savemain.cpp

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2020 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 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, either version 3 of the  License,
       |                              or (at your option) any later version.
     _/     /\                  You should have received  a copy of the GNU
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
 
#include <fc_config.h>
 
// Qt
#include <QDir>
#include <QString>
 
// utility
#include "fcthread.h"
#include "log.h"
#include "registry.h"
#include "registry_ini.h"
 
// common
#include "ai.h"
#include "capability.h"
#include "game.h"
 
// server
#include "console.h"
#include "notify.h"
 
/* server/savegame */
#include "savegame2.h"
#include "savegame3.h"
 
#include "savemain.h"
 
Q_GLOBAL_STATIC(fcThread, save_thread);
 
void savegame_load(struct section_file *sfile)
{
  const char *savefile_options;
 
  fc_assert_ret(sfile != nullptr);
 
  civtimer *loadtimer = timer_new(TIMER_CPU, TIMER_DEBUG);
  timer_start(loadtimer);
 
  savefile_options = secfile_lookup_str(sfile, "savefile.options");
 
  if (!savefile_options) {
    qCritical("Missing savefile options. Can not load the savegame.");
    return;
  }
 
  if (has_capabilities("+version3", savefile_options)) {
    // load new format (freeciv 3.0.x and newer)
    qDebug("loading savefile in 3.0+ format ...");
    savegame3_load(sfile);
  } else if (has_capabilities("+version2", savefile_options)) {
    // load old format (freeciv 2.3 - 2.6)
    qDebug("loading savefile in 2.3 - 2.6 format ...");
    savegame2_load(sfile);
  } else {
    qCritical("Too old savegame format not supported any more.");
    return;
  }
 
  players_iterate(pplayer)
  {
    unit_list_iterate(pplayer->units, punit)
    {
      CALL_FUNC_EACH_AI(unit_created, punit);
      CALL_PLR_AI_FUNC(unit_got, pplayer, punit);
    }
    unit_list_iterate_end;
 
    city_list_iterate(pplayer->cities, pcity)
    {
      CALL_FUNC_EACH_AI(city_created, pcity);
      CALL_PLR_AI_FUNC(city_got, pplayer, pplayer, pcity);
    }
    city_list_iterate_end;
  }
  players_iterate_end;
 
  timer_stop(loadtimer);
  qCDebug(timers_category, "Loading secfile in %.3f seconds.",
          timer_read_seconds(loadtimer));
  timer_destroy(loadtimer);
}
 
void savegame_save(struct section_file *sfile, const char *save_reason,
                   bool scenario)
{
  savegame3_save(sfile, save_reason, scenario);
}
 
struct save_thread_data {
  struct section_file *sfile;
  char filepath[600];
  compress_type save_compress_type;
};
 
static void save_thread_run(void *arg)
{
  struct save_thread_data *stdata =
      static_cast<struct save_thread_data *>(arg);
 
  if (!secfile_save(stdata->sfile, stdata->filepath)) {
    con_write(C_FAIL, _("Failed saving game as %s"), stdata->filepath);
    qCritical("Game saving failed: %s", secfile_error());
    notify_conn(nullptr, nullptr, E_LOG_ERROR, ftc_warning,
                _("Failed saving game."));
  } else {
    con_write(C_OK, _("Game saved as %s"), stdata->filepath);
  }
 
  secfile_destroy(stdata->sfile);
  delete stdata;
}
 
void save_game(const char *orig_filename, const char *save_reason,
               bool scenario)
{
  char *dot, *filename;
  civtimer *timer_cpu;
  struct save_thread_data *stdata = new save_thread_data();
 
  stdata->save_compress_type = game.server.save_compress_type;
 
  if (!orig_filename) {
    stdata->filepath[0] = '\0';
    filename = stdata->filepath;
  } else {
    sz_strlcpy(stdata->filepath, orig_filename);
    filename = strrchr(stdata->filepath, '/');
    if (filename) {
      filename++;
    } else {
      filename = stdata->filepath;
    }
 
    // Ignores the dot at the start of the filename.
    for (dot = filename; '.' == *dot; dot++) {
      // Nothing.
    }
    if ('\0' == *dot) {
      // Only dots in this file name, consider it as empty.
      filename[0] = '\0';
    } else {
      char *end_dot;
      const char *strip_extensions[] = {".sav", ".gz",  ".bz2",
                                        ".xz",  ".zst", nullptr};
      bool stripped = true;
 
      while ((end_dot = strrchr(dot, '.')) && stripped) {
        int i;
 
        stripped = false;
 
        for (i = 0; strip_extensions[i] != nullptr && !stripped; i++) {
          if (!strcmp(end_dot, strip_extensions[i])) {
            *end_dot = '\0';
            stripped = true;
          }
        }
      }
    }
  }
 
  // If orig_filename is nullptr or empty, use a generated default name.
  if (filename[0] == '\0') {
    // manual save
    generate_save_name(
        game.server.save_name, filename,
        sizeof(stdata->filepath) + stdata->filepath - filename, "manual");
  }
 
  timer_cpu = timer_new(TIMER_CPU, TIMER_ACTIVE);
  timer_start(timer_cpu);
 
  /* Allowing duplicates shouldn't be allowed. However, it takes very too
   * long time for huge game saving... */
  stdata->sfile = secfile_new(true);
  savegame_save(stdata->sfile, save_reason, scenario);
 
  /* We have consistent game state in stdata->sfile now, so
   * we could pass it to the saving thread already. We want to
   * handle below notify_conn() and directory creation in
   * main thread, though. */
 
  // Append ".sav" to filename.
  sz_strlcat(stdata->filepath, ".sav");
 
  {
    switch (stdata->save_compress_type) {
    case COMPRESS_ZLIB:
      // Append ".gz" to filename.
      sz_strlcat(stdata->filepath, ".gz");
      break;
#ifdef FREECIV_HAVE_BZ2
    case COMPRESS_BZIP2:
      // Append ".bz2" to filename.
      sz_strlcat(stdata->filepath, ".bz2");
      break;
#endif
#ifdef FREECIV_HAVE_LZMA
    case COMPRESS_XZ:
      // Append ".xz" to filename.
      sz_strlcat(stdata->filepath, ".xz");
      break;
#endif
#ifdef FREECIV_HAVE_ZSTD
    case COMPRESS_ZSTD:
      // Append ".zst" to filename.
      sz_strlcat(stdata->filepath, ".zst");
      break;
#endif
    case COMPRESS_PLAIN:
      break;
    default:
      qCritical(_("Unsupported compression type %d."),
                stdata->save_compress_type);
      notify_conn(nullptr, nullptr, E_SETTING, ftc_warning,
                  _("Unsupported compression type %d."),
                  stdata->save_compress_type);
      break;
    }
  }
 
  if (!QFileInfo(stdata->filepath).isAbsolute()) {
    QString tmpname;
 
    if (!scenario) {
      // Ensure the saves directory exists.
      if (!srvarg.saves_pathname.isEmpty()) {
        QDir().mkpath(srvarg.saves_pathname);
      }
      tmpname = srvarg.saves_pathname;
    } else {
      // Make sure scenario directory exist
      if (!srvarg.scenarios_pathname.isEmpty()) {
        QDir().mkpath(srvarg.scenarios_pathname);
      }
      tmpname = srvarg.scenarios_pathname;
    }
 
    if (!tmpname.isEmpty()) {
      tmpname += QLatin1String("/");
    }
    tmpname += QString::fromUtf8(stdata->filepath);
    sz_strlcpy(stdata->filepath, qUtf8Printable(tmpname));
  }
 
  // Don't start another thread if game is being saved now
  if (!save_thread->isRunning()) {
    save_thread->set_func(save_thread_run, stdata);
    save_thread->start(QThread::LowestPriority);
  }
 
  log_time(QStringLiteral("Save time: %1 seconds")
               .arg(timer_read_seconds(timer_cpu)));
  timer_destroy(timer_cpu);
}
 
void save_system_close() { save_thread->wait(); }