savemain.c

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   This program 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 2, or (at your option)
   any later version.
 
   This program 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.
***********************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif
 
/* utility */
#include "log.h"
#include "mem.h"
#include "registry.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"
 
static fc_thread *save_thread = nullptr;
 
/************************************************************************/
void savegame_load(struct section_file *sfile)
{
  const char *savefile_options;
 
  fc_assert_ret(sfile != nullptr);
 
#ifdef DEBUG_TIMERS
  struct timer *loadtimer = timer_new(TIMER_CPU, TIMER_DEBUG, "load");
  timer_start(loadtimer);
#endif // DEBUG_TIMERS
 
  savefile_options = secfile_lookup_str(sfile, "savefile.options");
 
  if (savefile_options == nullptr) {
    log_error("Missing savefile options. Can not load the savegame.");
    return;
  }
 
  if (has_capabilities("+version3", savefile_options)) {
    /* Load new format (freeciv 3.0.x and newer) */
    log_verbose("loading savefile in 3.0+ format ...");
    savegame3_load(sfile);
  } else if (has_capabilities("+version2", savefile_options)) {
    /* Load old format (freeciv 2.3 - 2.6) */
    log_verbose("loading savefile in 2.3 - 2.6 format ...");
    savegame2_load(sfile);
  } else {
    log_error("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;
 
#ifdef DEBUG_TIMERS
  timer_stop(loadtimer);
  log_debug("Loading secfile in %.3f seconds.", timer_read_seconds(loadtimer));
  timer_destroy(loadtimer);
#endif // DEBUG_TIMERS
}
 
/************************************************************************/
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];
  int save_compress_level;
  enum fz_method save_compress_type;
};
 
/************************************************************************/
static void save_thread_data_free(struct save_thread_data *stdata)
{
  secfile_destroy(stdata->sfile);
  free(stdata);
}
 
/************************************************************************/
static void save_thread_run(void *arg)
{
  struct save_thread_data *stdata = (struct save_thread_data *)arg;
 
  if (!secfile_save(stdata->sfile, stdata->filepath, stdata->save_compress_level,
                    stdata->save_compress_type)) {
    con_write(C_FAIL, _("Failed saving game as %s"), stdata->filepath);
    log_error("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);
  }
 
  save_thread_data_free(stdata);
}
 
/************************************************************************/
void save_game(const char *orig_filename, const char *save_reason,
               bool scenario)
{
  char *dot, *filename;
  struct timer *timer_cpu, *timer_user;
  struct save_thread_data *stdata;
 
  stdata = fc_malloc(sizeof(*stdata));
 
  stdata->save_compress_type = game.server.save_compress_type;
  stdata->save_compress_level = game.server.save_compress_level;
 
  if (orig_filename == nullptr) {
    stdata->filepath[0] = '\0';
    filename = stdata->filepath;
  } else {
    sz_strlcpy(stdata->filepath, orig_filename);
    if ((filename = strrchr(stdata->filepath, '/'))) {
      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;
      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, "save cpu");
  timer_user = timer_new(TIMER_USER, TIMER_ACTIVE, "save user");
  timer_start(timer_cpu);
  timer_start(timer_user);
 
  /* 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");
 
  if (stdata->save_compress_level > 0) {
    switch (stdata->save_compress_type) {
#ifdef FREECIV_HAVE_LIBZ
    case FZ_ZLIB:
      /* Append ".gz" to filename. */
      sz_strlcat(stdata->filepath, ".gz");
      break;
#endif
#ifdef FREECIV_HAVE_LIBLZMA
   case FZ_XZ:
      /* Append ".xz" to filename. */
      sz_strlcat(stdata->filepath, ".xz");
      break;
#endif
#ifdef FREECIV_HAVE_LIBZSTD
   case FZ_ZSTD:
      /* Append ".zstd" to filename. */
      sz_strlcat(stdata->filepath, ".zst");
      break;
#endif /* FREECIV_HAVE_LIBZSTD */
    case FZ_PLAIN:
      break;
    default:
      log_error(_("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 (!path_is_absolute(stdata->filepath)) {
    char tmpname[600];
 
    if (!scenario) {
      /* Ensure the saves directory exists. */
      if (srvarg.saves_pathname[0] != '\0'
          && !make_dir(srvarg.saves_pathname, DIRMODE_DEFAULT)) {
        log_error(_("Can't create saves directory %s!"),
                  srvarg.saves_pathname);
        /* Don't tell server paths to clients */
        notify_conn(nullptr, nullptr, E_SETTING, ftc_warning,
                    _("Can't create saves directory!"));
 
        save_thread_data_free(stdata);
        timer_destroy(timer_cpu);
        timer_destroy(timer_user);
 
        return;
      }
 
      sz_strlcpy(tmpname, srvarg.saves_pathname);
    } else {
      /* Make sure scenario directory exist */
      if (srvarg.scenarios_pathname[0] != '\0'
          && !make_dir(srvarg.scenarios_pathname, DIRMODE_DEFAULT)) {
        log_error(_("Can't create scenario saves directory %s!"),
                  srvarg.scenarios_pathname);
        /* Don't tell server paths to clients */
        notify_conn(nullptr, nullptr, E_SETTING, ftc_warning,
                    _("Can't create scenario saves directory!"));
 
        save_thread_data_free(stdata);
        timer_destroy(timer_cpu);
        timer_destroy(timer_user);
 
        return;
      }
 
      sz_strlcpy(tmpname, srvarg.scenarios_pathname);
    }
 
    if (tmpname[0] != '\0') {
      sz_strlcat(tmpname, "/");
    }
    sz_strlcat(tmpname, stdata->filepath);
    sz_strlcpy(stdata->filepath, tmpname);
  }
 
  if (save_thread != nullptr) {
    /* Previously started thread */
    fc_thread_wait(save_thread);
    if (!game.server.threaded_save) {
      /* Setting has changed since the last save */
      free(save_thread);
      save_thread = nullptr;
    }
  } else if (game.server.threaded_save) {
    save_thread = fc_malloc(sizeof(save_thread));
  }
 
  if (save_thread != nullptr) {
    fc_thread_start(save_thread, &save_thread_run, stdata);
  } else {
    save_thread_run(stdata);
  }
 
#ifdef LOG_TIMERS
  log_verbose("Save time: %g seconds (%g apparent)",
              timer_read_seconds(timer_cpu), timer_read_seconds(timer_user));
#endif // LOG_TIMERS
 
  timer_destroy(timer_cpu);
  timer_destroy(timer_user);
}
 
/************************************************************************/
void save_system_close(void)
{
  if (save_thread != nullptr) {
    fc_thread_wait(save_thread);
    free(save_thread);
    save_thread = nullptr;
  }
}