eqemu-server/common/repositories/expeditions_repository.h

/**
 * EQEmulator: Everquest Server Emulator
 * Copyright (C) 2001-2020 EQEmulator Development Team (https://github.com/EQEmu/Server)
 *
 * 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; version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY except by those people which sell it, which
 * are required to give you total support for your newly bought product;
 * 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */

#ifndef EQEMU_EXPEDITIONS_REPOSITORY_H
#define EQEMU_EXPEDITIONS_REPOSITORY_H

#include "../database.h"
#include "../string_util.h"
#include "base/base_expeditions_repository.h"

class ExpeditionsRepository: public BaseExpeditionsRepository {
public:

    /**
     * This file was auto generated and can be modified and extended upon
     *
     * Base repository methods are automatically
     * generated in the "base" version of this repository. The base repository
     * is immutable and to be left untouched, while methods in this class
     * are used as extension methods for more specific persistence-layer
     * accessors or mutators.
     *
     * Base Methods (Subject to be expanded upon in time)
     *
     * Note: Not all tables are designed appropriately to fit functionality with all base methods
     *
     * InsertOne
     * UpdateOne
     * DeleteOne
     * FindOne
     * GetWhere(std::string where_filter)
     * DeleteWhere(std::string where_filter)
     * InsertMany
     * All
     *
     * Example custom methods in a repository
     *
     * ExpeditionsRepository::GetByZoneAndVersion(int zone_id, int zone_version)
     * ExpeditionsRepository::GetWhereNeverExpires()
     * ExpeditionsRepository::GetWhereXAndY()
     * ExpeditionsRepository::DeleteWhereXAndY()
     *
     * Most of the above could be covered by base methods, but if you as a developer
     * find yourself re-using logic for other parts of the code, its best to just make a
     * method that can be re-used easily elsewhere especially if it can use a base repository
     * method and encapsulate filters there
     */

	// Custom extended repository methods here

	struct ExpeditionWithLeader
	{
		uint32_t    id;
		std::string uuid;
		uint32_t    dynamic_zone_id;
		std::string expedition_name;
		uint32_t    min_players;
		uint32_t    max_players;
		int         add_replay_on_join;
		int         is_locked;
		uint32_t    leader_id;
		std::string leader_name;
	};

	static std::string SelectExpeditionsJoinLeader()
	{
		return std::string(SQL(
			SELECT
				expeditions.id,
				expeditions.uuid,
				expeditions.dynamic_zone_id,
				expeditions.expedition_name,
				expeditions.min_players,
				expeditions.max_players,
				expeditions.add_replay_on_join,
				expeditions.is_locked,
				expeditions.leader_id,
				character_data.name leader_name
			FROM expeditions
				INNER JOIN character_data ON expeditions.leader_id = character_data.id
		));
	}

	static ExpeditionWithLeader FillExpeditionWithLeaderFromRow(MySQLRequestRow& row)
	{
		ExpeditionWithLeader entry{};

		int col = 0;
		entry.id                 = strtoul(row[col++], nullptr, 10);
		entry.uuid               = row[col++];
		entry.dynamic_zone_id    = strtoul(row[col++], nullptr, 10);
		entry.expedition_name    = row[col++];
		entry.min_players        = strtoul(row[col++], nullptr, 10);
		entry.max_players        = strtoul(row[col++], nullptr, 10);
		entry.add_replay_on_join = strtoul(row[col++], nullptr, 10);
		entry.is_locked          = strtoul(row[col++], nullptr, 10);
		entry.leader_id          = strtoul(row[col++], nullptr, 10);
		entry.leader_name        = row[col++];

		return entry;
	}

	static std::vector<ExpeditionWithLeader> GetAllWithLeaderName(Database& db)
	{
		std::vector<ExpeditionWithLeader> all_entries;

		auto results = db.QueryDatabase(fmt::format(
			"{} ORDER BY expeditions.id;",
			SelectExpeditionsJoinLeader()
		));

		if (results.Success())
		{
			all_entries.reserve(results.RowCount());

			for (auto row = results.begin(); row != results.end(); ++row)
			{
				ExpeditionWithLeader entry = FillExpeditionWithLeaderFromRow(row);
				all_entries.emplace_back(std::move(entry));
			}
		}

		return all_entries;
	}

	static ExpeditionWithLeader GetWithLeaderName(Database& db, uint32_t expedition_id)
	{
		ExpeditionWithLeader entry{};

		auto results = db.QueryDatabase(fmt::format(
			"{} WHERE expeditions.id = {};",
			SelectExpeditionsJoinLeader(),
			expedition_id
		));

		if (results.Success() && results.RowCount() > 0)
		{
			auto row = results.begin();
			entry = FillExpeditionWithLeaderFromRow(row);
		}

		return entry;
	}

	struct CharacterExpedition
	{
		uint32_t    id;
		std::string name;
		uint32_t    expedition_id;
	};

	static std::vector<CharacterExpedition> GetCharactersWithExpedition(
		Database& db, const std::vector<std::string>& character_names)
	{
		if (character_names.empty())
		{
			return {};
		}

		std::vector<CharacterExpedition> entries;

		auto joined_character_names = fmt::format("'{}'", fmt::join(character_names, "','"));

		auto results = db.QueryDatabase(fmt::format(SQL(
			SELECT
				character_data.id,
				character_data.name,
				MAX(expeditions.id)
			FROM character_data
				LEFT JOIN dynamic_zone_members
					ON character_data.id = dynamic_zone_members.character_id
					AND dynamic_zone_members.is_current_member = TRUE
				LEFT JOIN expeditions
					ON dynamic_zone_members.dynamic_zone_id = expeditions.dynamic_zone_id
			WHERE character_data.name IN ({})
			GROUP BY character_data.id
			ORDER BY FIELD(character_data.name, {})
		),
			joined_character_names,
			joined_character_names
		));

		if (results.Success())
		{
			entries.reserve(results.RowCount());

			for (auto row = results.begin(); row != results.end(); ++row)
			{
				CharacterExpedition entry{};
				entry.id            = std::strtoul(row[0], nullptr, 10);
				entry.name          = row[1];
				entry.expedition_id = row[2] ? std::strtoul(row[2], nullptr, 10) : 0;

				entries.emplace_back(std::move(entry));
			}
		}

		return entries;
	}

	static uint32_t GetIDByMemberID(Database& db, uint32_t character_id)
	{
		if (character_id == 0)
		{
			return 0;
		}

		uint32_t expedition_id = 0;

		auto results = db.QueryDatabase(fmt::format(SQL(
			SELECT
				expeditions.id
			FROM expeditions
				INNER JOIN dynamic_zone_members
					ON expeditions.dynamic_zone_id = dynamic_zone_members.dynamic_zone_id
			WHERE
				dynamic_zone_members.character_id = {}
				AND dynamic_zone_members.is_current_member = TRUE;
		),
			character_id
		));

		if (results.Success() && results.RowCount() > 0)
		{
			auto row = results.begin();
			expedition_id = std::strtoul(row[0], nullptr, 10);
		}

		return expedition_id;
	}
};

#endif //EQEMU_EXPEDITIONS_REPOSITORY_H