fios.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD 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 Foundation, version 2.
 * OpenTTD 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 OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "3rdparty/md5/md5.h"
#include "core/string_consumer.hpp"
#include "fileio_func.h"
#include "fios.h"
#include "network/network_content.h"
#include "screenshot.h"
#include "string_func.h"
#include "strings_func.h"
#include "tar_type.h"
#include <sys/stat.h>
#include <charconv>
#include <filesystem>
 
#include "table/strings.h"
 
#include "safeguards.h"
 
static std::string *_fios_path = nullptr;
 
/* OS-specific functions are taken from their respective files (win32/unix .c) */
extern bool FiosIsRoot(const std::string &path);
extern bool FiosIsHiddenFile(const std::filesystem::path &path);
extern void FiosGetDrives(FileList &file_list);
 
/* get the name of an oldstyle savegame */
extern std::string GetOldSaveGameName(std::string_view file);

bool FiosItemNameSorter(const FiosItem &a, const FiosItem &b)
{
  return StrNaturalCompare(a.title.GetDecodedString(), b.title.GetDecodedString()) < 0;
}

bool FiosItemModificationDateSorter(const FiosItem &a, const FiosItem &b)
{
  if (a.mtime == b.mtime) return FiosItemNameSorter(a, b);
  return a.mtime < b.mtime;
}

void FileList::BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop, bool show_dirs)
{
  this->clear();
 
  assert(fop == SaveLoadOperation::Load || fop == SaveLoadOperation::Save);
  switch (abstract_filetype) {
    case AbstractFileType::None:
      break;
 
    case AbstractFileType::Savegame:
      FiosGetSavegameList(fop, show_dirs, *this);
      break;
 
    case AbstractFileType::Scenario:
      FiosGetScenarioList(fop, show_dirs, *this);
      break;
 
    case AbstractFileType::Heightmap:
      FiosGetHeightmapList(fop, show_dirs, *this);
      break;
 
    case AbstractFileType::TownData:
      FiosGetTownDataList(fop, show_dirs, *this);
      break;
 
    default:
      NOT_REACHED();
  }
}

const FiosItem *FileList::FindItem(std::string_view file)
{
  for (const auto &it : *this) {
    const FiosItem *item = &it;
    if (file == item->name) return item;
    if (file == item->title.GetDecodedString()) return item;
  }
 
  /* If no name matches, try to parse it as number */
  StringConsumer consumer{file};
  auto number = consumer.TryReadIntegerBase<int>(10);
  if (number.has_value() && !consumer.AnyBytesLeft() && IsInsideMM(*number, 0, this->size())) return &this->at(*number);
 
  /* As a last effort assume it is an OpenTTD savegame and
   * that the ".sav" part was not given. */
  std::string long_file(file);
  long_file += ".sav";
  for (const auto &it : *this) {
    const FiosItem *item = &it;
    if (long_file == item->name) return item;
    if (long_file == item->title.GetDecodedString()) return item;
  }
 
  return nullptr;
}

std::string FiosGetCurrentPath()
{
  return *_fios_path;
}

DirectoryCreateResult FiosCreateDirectory(std::string_view name)
{
  assert(_fios_path != nullptr);
 
  /* Remove trailing path separator, if present. */
  std::string_view base = *_fios_path;
  if (!base.empty() && base.back() == PATHSEPCHAR) base.remove_suffix(1);
  /* Join with a single separator, converting via OTTD2FS so non-ASCII names work on Windows. */
  std::filesystem::path target = OTTD2FS(fmt::format("{}{}{}", base, PATHSEP, name));
 
  std::error_code error_code;
  if (std::filesystem::create_directory(target, error_code)) {
    return DirectoryCreateResult::Success;
  }
 
  /* A false return with no error means the target already exists. Confirm it is a directory to tell it apart from a stray file or other entry. */
  if (!error_code) {
    return std::filesystem::is_directory(target, error_code) ? DirectoryCreateResult::AlreadyExists : DirectoryCreateResult::OtherError;
  }
 
  /* An existing non-directory file shows up here as file_exists. */
  if (error_code == std::errc::file_exists) return DirectoryCreateResult::AlreadyExists;
  if (error_code == std::errc::permission_denied || error_code == std::errc::read_only_file_system) return DirectoryCreateResult::PermissionDenied;
  return DirectoryCreateResult::OtherError;
}

bool FiosBrowseTo(const FiosItem *item)
{
  switch (item->type.detailed) {
    case DetailedFileType::FiosDrive:
#if defined(_WIN32)
      assert(_fios_path != nullptr);
      *_fios_path = std::string{ item->name, 0, 1 } + ":" PATHSEP;
#endif
      break;
 
    case DetailedFileType::Invalid:
      break;
 
    case DetailedFileType::FiosParent: {
      assert(_fios_path != nullptr);
      auto s = _fios_path->find_last_of(PATHSEPCHAR);
      if (s != std::string::npos && s != 0) {
        _fios_path->erase(s); // Remove last path separator character, so we can go up one level.
      }
 
      s = _fios_path->find_last_of(PATHSEPCHAR);
      if (s != std::string::npos) {
        _fios_path->erase(s + 1); // go up a directory
      }
      break;
    }
 
    case DetailedFileType::FiosDirectory:
      assert(_fios_path != nullptr);
      *_fios_path += item->name;
      *_fios_path += PATHSEP;
      break;
 
    case DetailedFileType::FiosDirect:
      assert(_fios_path != nullptr);
      *_fios_path = item->name;
      break;
 
    default:
      return false;
  }
 
  return true;
}

static std::string FiosMakeFilename(const std::string *path, std::string_view name, std::string_view ext)
{
  std::string_view base_path;
 
  if (path != nullptr) {
    base_path = *path;
    /* Remove trailing path separator, if present */
    if (!base_path.empty() && base_path.back() == PATHSEPCHAR) base_path.remove_suffix(1);
  }
 
  /* Don't append the extension if it is already there */
  auto period = name.find_last_of('.');
  if (period != std::string_view::npos && StrEqualsIgnoreCase(name.substr(period), ext)) ext = "";
 
  return fmt::format("{}{}{}{}", base_path, PATHSEP, name, ext);
}

std::string FiosMakeSavegameName(std::string_view name)
{
  std::string_view extension = (_game_mode == GameMode::Editor) ? ".scn" : ".sav";
 
  return FiosMakeFilename(_fios_path, name, extension);
}

std::string FiosMakeHeightmapName(std::string_view name)
{
  return FiosMakeFilename(_fios_path, name, fmt::format(".{}", GetCurrentScreenshotExtension()));
}
 
typedef std::tuple<FiosType, std::string> FiosGetTypeAndNameProc(SaveLoadOperation fop, std::string_view filename, std::string_view ext);

class FiosFileScanner : public FileScanner {
  SaveLoadOperation fop;   
  FiosGetTypeAndNameProc *callback_proc; 
  FileList &file_list;     
public:
  FiosFileScanner(SaveLoadOperation fop, FiosGetTypeAndNameProc *callback_proc, FileList &file_list) :
      fop(fop), callback_proc(callback_proc), file_list(file_list)
  {}
 
  bool AddFile(const std::string &filename, size_t, const std::string &) override;
};

bool FiosFileScanner::AddFile(const std::string &filename, size_t, const std::string &)
{
  auto sep = filename.rfind('.');
  if (sep == std::string::npos) return false;
  std::string ext = filename.substr(sep);
 
  auto [type, title] = this->callback_proc(this->fop, filename, ext);
  if (type == FIOS_TYPE_INVALID) return false;
 
  for (const auto &fios : file_list) {
    if (filename == fios.name) return false;
  }
 
  FiosItem *fios = &file_list.emplace_back();
 
  std::error_code error_code;
  auto write_time = std::filesystem::last_write_time(OTTD2FS(filename), error_code);
  if (error_code) {
    fios->mtime = 0;
  } else {
    fios->mtime = std::chrono::duration_cast<std::chrono::milliseconds>(write_time.time_since_epoch()).count();
  }
 
  fios->type = type;
  fios->name = filename;
 
  /* If the file doesn't have a title, use its filename */
  if (title.empty()) {
    auto ps = filename.rfind(PATHSEPCHAR);
    fios->title = GetEncodedString(STR_JUST_RAW_STRING, StrMakeValid(filename.substr((ps == std::string::npos ? 0 : ps + 1))));
  } else {
    fios->title = GetEncodedString(STR_JUST_RAW_STRING, StrMakeValid(title));
  };
 
  return true;
}
 

static void FiosGetFileList(SaveLoadOperation fop, bool show_dirs, FiosGetTypeAndNameProc *callback_proc, Subdirectory subdir, FileList &file_list)
{
  size_t sort_start = 0;
 
  file_list.clear();
 
  assert(_fios_path != nullptr);
 
  if (show_dirs) {
    /* A parent directory link exists if we are not in the root directory */
    if (!FiosIsRoot(*_fios_path)) {
      FiosItem &fios = file_list.emplace_back();
      fios.type = FIOS_TYPE_PARENT;
      fios.mtime = 0;
      fios.name = "..";
      fios.title = GetEncodedString(STR_SAVELOAD_PARENT_DIRECTORY, ".."sv);
      sort_start = file_list.size();
    }
 
    /* Show subdirectories */
    std::error_code error_code;
    for (const auto &dir_entry : std::filesystem::directory_iterator(OTTD2FS(*_fios_path), error_code)) {
      if (!dir_entry.is_directory()) continue;
      if (FiosIsHiddenFile(dir_entry) && dir_entry.path().filename() != PERSONAL_DIR) continue;
 
      FiosItem &fios = file_list.emplace_back();
      fios.type = FIOS_TYPE_DIR;
      fios.mtime = 0;
      fios.name = FS2OTTD(dir_entry.path().filename().native());
      fios.title = GetEncodedString(STR_SAVELOAD_DIRECTORY, fios.name + PATHSEP);
    }
 
    /* Sort the subdirs always ascending by name. */
    std::sort(file_list.begin() + sort_start, file_list.end(), FiosItemNameSorter);
  }
 
  /* This is where to start sorting for the filenames */
  sort_start = file_list.size();
 
  /* Show files */
  FiosFileScanner scanner(fop, callback_proc, file_list);
  if (subdir == Subdirectory::None) {
    scanner.Scan({}, *_fios_path, false);
  } else {
    scanner.Scan({}, subdir, true, true);
  }
 
  std::sort(file_list.begin() + sort_start, file_list.end(), FiosItemSorter);
 
  /* Show drives */
  FiosGetDrives(file_list);
}

static std::string GetFileTitle(std::string_view file, Subdirectory subdir)
{
  std::string filename = fmt::format("{}.title", file);
  auto f = FioFOpenFile(filename, "r", subdir);
  if (!f.has_value()) return {};
 
  char title[80];
  size_t read = fread(title, 1, lengthof(title), *f);
 
  assert(read <= lengthof(title));
  return StrMakeValid(std::string_view{title, read});
}

std::tuple<FiosType, std::string> FiosGetSavegameListCallback(SaveLoadOperation fop, std::string_view file, std::string_view ext)
{
  /* Show savegame files
   * .SAV OpenTTD saved game
   * .SS1 Transport Tycoon Deluxe preset game
   * .SV1 Transport Tycoon Deluxe (Patch) saved game
   * .SV2 Transport Tycoon Deluxe (Patch) saved 2-player game */
 
  if (StrEqualsIgnoreCase(ext, ".sav")) {
    return { FIOS_TYPE_FILE, GetFileTitle(file, Subdirectory::Save) };
  }
 
  if (fop == SaveLoadOperation::Load) {
    if (StrEqualsIgnoreCase(ext, ".ss1") || StrEqualsIgnoreCase(ext, ".sv1") ||
        StrEqualsIgnoreCase(ext, ".sv2")) {
      return { FIOS_TYPE_OLDFILE, GetOldSaveGameName(file) };
    }
  }
 
  return { FIOS_TYPE_INVALID, {} };
}

void FiosGetSavegameList(SaveLoadOperation fop, bool show_dirs, FileList &file_list)
{
  static std::optional<std::string> fios_save_path;
 
  if (!fios_save_path) fios_save_path = FioFindDirectory(Subdirectory::Save);
 
  _fios_path = &(*fios_save_path);
 
  FiosGetFileList(fop, show_dirs, &FiosGetSavegameListCallback, Subdirectory::None, file_list);
}

std::tuple<FiosType, std::string> FiosGetScenarioListCallback(SaveLoadOperation fop, std::string_view file, std::string_view ext)
{
  /* Show scenario files
   * .SCN OpenTTD style scenario file
   * .SV0 Transport Tycoon Deluxe (Patch) scenario
   * .SS0 Transport Tycoon Deluxe preset scenario */
  if (StrEqualsIgnoreCase(ext, ".scn")) {
    return { FIOS_TYPE_SCENARIO, GetFileTitle(file, Subdirectory::Scenario) };
 
  }
 
  if (fop == SaveLoadOperation::Load) {
    if (StrEqualsIgnoreCase(ext, ".sv0") || StrEqualsIgnoreCase(ext, ".ss0")) {
      return { FIOS_TYPE_OLD_SCENARIO, GetOldSaveGameName(file) };
    }
  }
 
  return { FIOS_TYPE_INVALID, {} };
}

void FiosGetScenarioList(SaveLoadOperation fop, bool show_dirs, FileList &file_list)
{
  static std::optional<std::string> fios_scn_path;
 
  /* Copy the default path on first run or on 'New Game' */
  if (!fios_scn_path) fios_scn_path = FioFindDirectory(Subdirectory::Scenario);
 
  _fios_path = &(*fios_scn_path);
 
  std::string base_path = FioFindDirectory(Subdirectory::Scenario);
  Subdirectory subdir = (fop == SaveLoadOperation::Load && base_path == *_fios_path) ? Subdirectory::Scenario : Subdirectory::None;
  FiosGetFileList(fop, show_dirs, &FiosGetScenarioListCallback, subdir, file_list);
}
 
std::tuple<FiosType, std::string> FiosGetHeightmapListCallback(SaveLoadOperation, std::string_view file, std::string_view ext)
{
  /* Show heightmap files
   * .PNG PNG Based heightmap files
   * .BMP BMP Based heightmap files
   */
 
  FiosType type = FIOS_TYPE_INVALID;
 
#ifdef WITH_PNG
  if (StrEqualsIgnoreCase(ext, ".png")) type = FIOS_TYPE_PNG;
#endif /* WITH_PNG */
 
  if (StrEqualsIgnoreCase(ext, ".bmp")) type = FIOS_TYPE_BMP;
 
  if (type == FIOS_TYPE_INVALID) return { FIOS_TYPE_INVALID, {} };
 
  TarFileList::iterator it = _tar_filelist[Subdirectory::Scenario].find(file);
  if (it != _tar_filelist[Subdirectory::Scenario].end()) {
    /* If the file is in a tar and that tar is not in a heightmap
     * directory we are for sure not supposed to see it.
     * Examples of this are pngs part of documentation within
     * collections of NewGRFs or 32 bpp graphics replacement PNGs.
     */
    bool match = false;
    for (Searchpath sp : _valid_searchpaths) {
      std::string buf = FioGetDirectory(sp, Subdirectory::Heightmap);
 
      if (it->second.tar_filename.starts_with(buf)) {
        match = true;
        break;
      }
    }
 
    if (!match) return { FIOS_TYPE_INVALID, {} };
  }
 
  return { type, GetFileTitle(file, Subdirectory::Heightmap) };
}

void FiosGetHeightmapList(SaveLoadOperation fop, bool show_dirs, FileList &file_list)
{
  static std::optional<std::string> fios_hmap_path;
 
  if (!fios_hmap_path) fios_hmap_path = FioFindDirectory(Subdirectory::Heightmap);
 
  _fios_path = &(*fios_hmap_path);
 
  std::string base_path = FioFindDirectory(Subdirectory::Heightmap);
  Subdirectory subdir = base_path == *_fios_path ? Subdirectory::Heightmap : Subdirectory::None;
  FiosGetFileList(fop, show_dirs, &FiosGetHeightmapListCallback, subdir, file_list);
}

static std::tuple<FiosType, std::string> FiosGetTownDataListCallback(SaveLoadOperation fop, std::string_view file, std::string_view ext)
{
  if (fop == SaveLoadOperation::Load) {
    if (StrEqualsIgnoreCase(ext, ".json")) {
      return { FIOS_TYPE_JSON, GetFileTitle(file, Subdirectory::Save) };
    }
  }
 
  return { FIOS_TYPE_INVALID, {} };
}

void FiosGetTownDataList(SaveLoadOperation fop, bool show_dirs, FileList &file_list)
{
  static std::optional<std::string> fios_town_data_path;
 
  if (!fios_town_data_path) fios_town_data_path = FioFindDirectory(Subdirectory::Heightmap);
 
  _fios_path = &(*fios_town_data_path);
 
  std::string base_path = FioFindDirectory(Subdirectory::Heightmap);
  Subdirectory subdir = base_path == *_fios_path ? Subdirectory::Heightmap : Subdirectory::None;
  FiosGetFileList(fop, show_dirs, &FiosGetTownDataListCallback, subdir, file_list);
}

std::string_view FiosGetScreenshotDir()
{
  static std::optional<std::string> fios_screenshot_path;
 
  if (!fios_screenshot_path) fios_screenshot_path = FioFindDirectory(Subdirectory::Screenshot);
 
  return *fios_screenshot_path;
}

struct ScenarioIdentifier {
  uint32_t scenid;           
  MD5Hash md5sum;          
  std::string filename;    
 
  bool operator == (const ScenarioIdentifier &other) const
  {
    return this->scenid == other.scenid && this->md5sum == other.md5sum;
  }
};

class ScenarioScanner : protected FileScanner, public std::vector<ScenarioIdentifier> {
  bool scanned; 
public:
  ScenarioScanner() : scanned(false) {}

  void Scan(bool rescan)
  {
    if (this->scanned && !rescan) return;
 
    this->FileScanner::Scan(".id", Subdirectory::Scenario, true, true);
    this->scanned = true;
  }
 
  bool AddFile(const std::string &filename, size_t, const std::string &) override
  {
    auto f = FioFOpenFile(filename, "r", Subdirectory::Scenario);
    if (!f.has_value()) return false;
 
    ScenarioIdentifier id;
    int fret = fscanf(*f, "%u", &id.scenid);
    if (fret != 1) return false;
    id.filename = filename;
 
    Md5 checksum;
    uint8_t buffer[1024];
    size_t len, size;
 
    /* open the scenario file, but first get the name.
     * This is safe as we check on extension which
     * must always exist. */
    f = FioFOpenFile(filename.substr(0, filename.rfind('.')), "rb", Subdirectory::Scenario, &size);
    if (!f.has_value()) return false;
 
    /* calculate md5sum */
    while ((len = fread(buffer, 1, (size > sizeof(buffer)) ? sizeof(buffer) : size, *f)) != 0 && size != 0) {
      size -= len;
      checksum.Append(buffer, len);
    }
    checksum.Finish(id.md5sum);
 
    include(*this, id);
    return true;
  }
};

static ScenarioScanner _scanner;

std::optional<std::string_view> FindScenario(const ContentInfo &ci, bool md5sum)
{
  _scanner.Scan(false);
 
  for (ScenarioIdentifier &id : _scanner) {
    if (md5sum ? (id.md5sum == ci.md5sum)
               : (id.scenid == ci.unique_id)) {
      return id.filename;
    }
  }
 
  return std::nullopt;
}

bool HasScenario(const ContentInfo &ci, bool md5sum)
{
  return FindScenario(ci, md5sum).has_value();
}

void ScanScenarios()
{
  _scanner.Scan(true);
}

FiosNumberedSaveName::FiosNumberedSaveName(const std::string &prefix) : prefix(prefix), number(-1)
{
  static std::optional<std::string> _autosave_path;
  if (!_autosave_path) _autosave_path = FioFindDirectory(Subdirectory::Autosave);
 
  static std::string _prefix; 
 
  /* Callback for FiosFileScanner. */
  static FiosGetTypeAndNameProc *const proc = [](SaveLoadOperation, std::string_view file, std::string_view ext) {
    if (StrEqualsIgnoreCase(ext, ".sav") && file.starts_with(_prefix)) return std::tuple(FIOS_TYPE_FILE, std::string{});
    return std::tuple(FIOS_TYPE_INVALID, std::string{});
  };
 
  /* Prefix to check in the callback. */
  _prefix = *_autosave_path + this->prefix;
 
  /* Get the save list. */
  FileList list;
  FiosFileScanner scanner(SaveLoadOperation::Save, proc, list);
  scanner.Scan(".sav", *_autosave_path, false);
 
  /* Find the number for the most recent save, if any. */
  if (!list.empty()) {
    auto elem = std::ranges::max_element(list, FiosItemModificationDateSorter);
    std::string name = elem->title.GetDecodedString();
    std::from_chars(name.data() + this->prefix.size(), name.data() + name.size(), this->number);
  }
}

std::string FiosNumberedSaveName::Filename()
{
  if (++this->number >= _settings_client.gui.max_num_autosaves) this->number = 0;
  return fmt::format("{}{}.sav", this->prefix, this->number);
}

std::string FiosNumberedSaveName::Extension()
{
  return fmt::format("-{}.sav", this->prefix);
}