/*
 * 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>.
 */

/** @file ai_sl.cpp Handles the saveload part of the AIs. */

#include "../stdafx.h"
#include "../debug.h"

#include "saveload.h"
#include "compat/ai_sl_compat.h"

#include "../company_base.h"
#include "../string_func.h"

#include "../ai/ai.hpp"
#include "../ai/ai_config.hpp"
#include "../network/network.h"
#include "../ai/ai_instance.hpp"

#include "../safeguards.h"

static std::string _ai_saveload_name;
static int         _ai_saveload_version;
static std::string _ai_saveload_settings;
static bool        _ai_saveload_is_random;

static const SaveLoad _ai_company_desc[] = {
	   SLEG_SSTR("name",      _ai_saveload_name,         SLE_STR),
	   SLEG_SSTR("settings",  _ai_saveload_settings,     SLE_STR),
	SLEG_CONDVAR("version",   _ai_saveload_version,   SLE_UINT32, SLV_STORE_AI_VERSION, SL_MAX_VERSION),
	SLEG_CONDVAR("is_random", _ai_saveload_is_random,   SLE_BOOL, SLV_SPLIT_LOAD_WAIT_COUNTERS, SLV_AI_LOCAL_CONFIG),
};

static const SaveLoad _ai_running_desc[] = {
	SLEG_CONDSSTR("running_name",     _ai_saveload_name,        SLE_STR, SLV_AI_LOCAL_CONFIG, SL_MAX_VERSION),
	SLEG_CONDSSTR("running_settings", _ai_saveload_settings,    SLE_STR, SLV_AI_LOCAL_CONFIG, SL_MAX_VERSION),
	 SLEG_CONDVAR("running_version",  _ai_saveload_version,  SLE_UINT32, SLV_AI_LOCAL_CONFIG, SL_MAX_VERSION),
};

static void SaveReal_AIPL(int arg)
{
	CompanyID index = static_cast<CompanyID>(arg);
	AIConfig *config = AIConfig::GetConfig(index, AIConfig::ScriptSettingSource::ForceCurrentGame);

	if (config->HasScript()) {
		_ai_saveload_name = config->GetName();
		_ai_saveload_version = config->GetVersion();
	} else {
		/* No AI is configured for this so store an empty string as name. */
		_ai_saveload_name.clear();
		_ai_saveload_version = -1;
	}

	_ai_saveload_settings = config->SettingsToString();

	SlObject(nullptr, _ai_company_desc);

	if (!Company::IsValidAiID(index)) return;

	/* If the AI was active, store its data too */
	config = AIConfig::GetConfig(index);
	_ai_saveload_name = config->GetName();
	_ai_saveload_version = config->GetVersion();
	_ai_saveload_settings = config->SettingsToString();

	SlObject(nullptr, _ai_running_desc);
	AI::Save(index);

}

struct AIPLChunkHandler : ChunkHandler {
	AIPLChunkHandler() : ChunkHandler('AIPL', CH_TABLE) {}

	void Load() const override
	{
		const std::vector<SaveLoad> slt = SlCompatTableHeader(_ai_company_desc, _ai_company_sl_compat);

		/* Free all current data */
		for (CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
			AIConfig::GetConfig(c, AIConfig::ScriptSettingSource::ForceCurrentGame)->Change(std::nullopt);
		}

		CompanyID index;
		while ((index = (CompanyID)SlIterateArray()) != (CompanyID)-1) {
			if (index >= MAX_COMPANIES) SlErrorCorrupt("Too many AI configs");

			_ai_saveload_is_random = false;
			_ai_saveload_version = -1;
			SlObject(nullptr, slt);

			if (_game_mode == GameMode::Menu || (_networking && !_network_server)) {
				if (Company::IsValidAiID(index)) {
					SlObject(nullptr, _ai_running_desc);
					AIInstance::LoadEmpty();
				}
				continue;
			}

			AIConfig *config = AIConfig::GetConfig(index, AIConfig::ScriptSettingSource::ForceCurrentGame);
			if (_ai_saveload_name.empty() || _ai_saveload_is_random) {
				/* A random AI. */
				config->Change(std::nullopt, -1, false);
			} else {
				config->Change(_ai_saveload_name, _ai_saveload_version, false);
				if (!config->HasScript()) {
					/* No version of the AI available. Try to configure the
					 * latest version of the AI instead. */
					config->Change(_ai_saveload_name, -1, false);
					if (!config->HasScript()) {
						if (_ai_saveload_name != "%_dummy") {
							Debug(script, 0, "The savegame has an AI by the name '{}', version {} which is no longer available.", _ai_saveload_name, _ai_saveload_version);
							Debug(script, 0, "Configuration switched to Random AI.");
						}
					} else {
						Debug(script, 0, "The savegame has an AI by the name '{}', version {} which is no longer available.", _ai_saveload_name, _ai_saveload_version);
						Debug(script, 0, "The latest version of that AI has been configured instead");
					}
				}
			}
			config->StringToSettings(_ai_saveload_settings);

			if (!Company::IsValidAiID(index)) continue;

			/* Load the AI saved data */
			SlObject(nullptr, _ai_running_desc);

			Company::Get(index)->ai_config = std::make_unique<AIConfig>();
			config = Company::Get(index)->ai_config.get();
			config->Change(_ai_saveload_name, _ai_saveload_version, false);
			if (!config->HasScript()) {
				/* No version of the AI available that can load the data. Try to load the
				 * latest version of the AI instead. */
				config->Change(_ai_saveload_name, -1, false);
				if (!config->HasScript()) {
					if (_ai_saveload_name != "%_dummy") {
						Debug(script, 0, "The savegame has an AI by the name '{}', version {} which is no longer available.", _ai_saveload_name, _ai_saveload_version);
						Debug(script, 0, "A random other AI will be loaded in its place.");
					} else {
						Debug(script, 0, "The savegame had no AIs available at the time of saving.");
						Debug(script, 0, "A random available AI will be loaded now.");
					}
				} else {
					Debug(script, 0, "The savegame has an AI by the name '{}', version {} which is no longer available.", _ai_saveload_name, _ai_saveload_version);
					Debug(script, 0, "The latest version of that AI has been loaded instead, but it'll not get the savegame data as it's incompatible.");
				}
				/* Make sure the AI doesn't get the saveload data, as it was not the
				 *  writer of the saveload data in the first place */
				_ai_saveload_version = -1;
			}
			config->StringToSettings(_ai_saveload_settings);
			config->SetToLoadData(AIInstance::Load(_ai_saveload_version));
		}
	}

	void Save() const override
	{
		SlTableHeader(_ai_company_desc);

		for (CompanyID i = CompanyID::Begin(); i < MAX_COMPANIES; ++i) {
			SlSetArrayIndex(i);
			SlAutolength(SaveReal_AIPL, i.base());
		}
	}
};

static const AIPLChunkHandler AIPL;
static const ChunkHandlerRef ai_chunk_handlers[] = {
	AIPL,
};

extern const ChunkHandlerTable _ai_chunk_handlers(ai_chunk_handlers);
