io_store.hpp

/**
 * Canary - A free and open-source MMORPG server emulator
 * Copyright (©) 2019-2022 OpenTibiaBR <opentibiabr@outlook.com>
 * Repository: https://github.com/opentibiabr/canary
 * License: https://github.com/opentibiabr/canary/blob/main/LICENSE
 * Contributors: https://github.com/opentibiabr/canary/graphs/contributors
 * Website: https://docs.opentibiabr.org/
 */

#ifndef SRC_IO_IO_STORE_HPP_
#define SRC_IO_IO_STORE_HPP_

#include "utils/pugicast.h"

#include <map>
#include <string>
#include <vector>

// XML
enum class OfferTypes_t : uint8_t {
	NONE = 0,
	ITEM = 1,
	STACKABLE = 2,
	CHARGES = 3,
	OUTFIT = 4,
	MOUNT = 5,
	NAMECHANGE = 6,
	SEXCHANGE = 7,
	HOUSE = 8,
	EXPBOOST = 9,
	PREYSLOT = 10,
	PREYBONUS = 11,
	TEMPLE = 12,
	BLESSINGS = 13,
	ALLBLESSINGS = 14,
	PREMIUM = 15,
	POUCH = 16,
	INSTANT_REWARD_ACCESS = 17,
	CHARM_EXPANSION = 18,
	HUNTINGSLOT = 19,
	HIRELING = 20,
	HIRELING_NAMECHANGE = 21,
	HIRELING_SEXCHANGE = 22,
	HIRELING_SKILL = 23,
	HIRELING_OUTFIT = 24
};

enum class States_t : uint8_t {
	NONE = 0,
	NEW = 1,
	SALE = 2,
	TIMED = 3
};

// Internal
enum class ConverType_t : uint8_t {
	NONE = 0,
	MOUNT = 1,
	OUTFIT = 2,
	ITEM = 3,
	HIRELING = 4
};

enum class SubActions_t : uint8_t {
	PREY_THIRDSLOT_REAL = 0,
	PREY_WILDCARD = 1,
	INSTANT_REWARD = 2,
	BLESSING_TWIST = 3,
	BLESSING_SOLITUDE = 4,
	BLESSING_PHOENIX = 5,
	BLESSING_SUNS = 6,
	BLESSING_SPIRITUAL = 7,
	BLESSING_EMBRACE = 8,
	BLESSING_HEART = 9,
	BLESSING_BLOOD = 10,
	BLESSING_ALL_PVE = 11,
	BLESSING_ALL_PVP = 12,
	CHARM_EXPANSION = 13,
	TASKHUNTING_THIRDSLOT = 14,
	PREY_THIRDSLOT_REDIRECT = 15
};

enum class HistoryTypes_t : uint8_t {
	NONE = 0,
	GIFT = 1,
	REFUND = 2
};

enum class StoreErrors_t : uint8_t {
	PURCHASE = 0,
	NETWORK = 1,
	HISTORY = 2,
	TRANSFER = 3,
	INFORMATION = 4
};

// Others
enum class ActionType_t : uint8_t {
	OPEN_HOME = 0,
	OPEN_PREMIUM_BOOST = 1,
	OPEN_CATEGORY = 2,
	OPEN_USEFUL_THINGS = 3,
	OPEN_OFFER = 4,
};

enum class CoinType_t : uint8_t {
	COIN = 0,
	TRANSFERABLE = 1,
};

// Structs
struct OutfitIds {
	uint16_t maleId;
	uint16_t femaleId;
};

struct BannerInfo {
	std::string bannerName;
	uint32_t offerId;
};

class Category;
class Offer;

class IOStore {
public:
	IOStore(const IOStore&) = delete;
	void operator=(const IOStore&) = delete;

	static IOStore& getInstance() {
		static IOStore instance;
		return instance;
	}

	bool loadFromXml();

	const std::map<std::string, OfferTypes_t> stringToOfferTypeMap = {
		{ "none", OfferTypes_t::NONE },
		{ "item", OfferTypes_t::ITEM },
		{ "stackable", OfferTypes_t::STACKABLE },
		{ "charges", OfferTypes_t::CHARGES },
		{ "outfit", OfferTypes_t::OUTFIT },
		{ "mount", OfferTypes_t::MOUNT },
		{ "nameChange", OfferTypes_t::NAMECHANGE },
		{ "sexChange", OfferTypes_t::SEXCHANGE },
		{ "house", OfferTypes_t::HOUSE },
		{ "expBoost", OfferTypes_t::EXPBOOST },
		{ "preySlot", OfferTypes_t::PREYSLOT },
		{ "preyBonus", OfferTypes_t::PREYBONUS },
		{ "temple", OfferTypes_t::TEMPLE },
		{ "blessings", OfferTypes_t::BLESSINGS },
		{ "allblessings", OfferTypes_t::ALLBLESSINGS },
		{ "premium", OfferTypes_t::PREMIUM },
		{ "pouch", OfferTypes_t::POUCH },
		{ "instantReward", OfferTypes_t::INSTANT_REWARD_ACCESS },
		{ "charmExpansion", OfferTypes_t::CHARM_EXPANSION },
		{ "huntingSlot", OfferTypes_t::HUNTINGSLOT },
		{ "hireling", OfferTypes_t::HIRELING },
		{ "hirelingNameChange", OfferTypes_t::HIRELING_NAMECHANGE },
		{ "hirelingSexChange", OfferTypes_t::HIRELING_SEXCHANGE },
		{ "hirelingSkill", OfferTypes_t::HIRELING_SKILL },
		{ "hirelingOutfit", OfferTypes_t::HIRELING_OUTFIT }
	};

	const std::map<OfferTypes_t, uint16_t> offersDisableIndex = {
		{ OfferTypes_t::OUTFIT, 0 },
		{ OfferTypes_t::MOUNT, 1 },
		{ OfferTypes_t::EXPBOOST, 2 },
		{ OfferTypes_t::PREYSLOT, 3 },
		{ OfferTypes_t::HUNTINGSLOT, 3 },
		{ OfferTypes_t::PREYBONUS, 4 },
		{ OfferTypes_t::BLESSINGS, 5 },
		{ OfferTypes_t::ALLBLESSINGS, 6 },
		{ OfferTypes_t::POUCH, 7 },
		{ OfferTypes_t::INSTANT_REWARD_ACCESS, 8 },
		{ OfferTypes_t::CHARM_EXPANSION, 9 }
	};

	const std::map<std::string, States_t> stringToOfferStateMap = {
		{ "none", States_t::NONE }, { "new", States_t::NEW }, { "sale", States_t::SALE }, { "timed", States_t::TIMED }
	};

	std::vector<Category> getCategoryVector() const;
	const Category* getCategoryByName(std::string categoryName) const;
	const Category* getSubCategoryByName(std::string subCategoryName) const;
	const Offer* getOfferById(uint32_t offerId) const;

	std::vector<BannerInfo> getBannersVector() const;
	std::vector<uint32_t> getHomeOffersVector() const;
	uint32_t getBannerDelay() const;
	void setBannerDelay(uint8_t delay);

	const Category* findCategory(std::string categoryName);

	const std::vector<std::string> getOffersDisableReasonVector();

	std::vector<Offer> getOffersContainingSubstring(const std::string &searchString);

private:
	IOStore() = default;
	~IOStore() = default;

	// Home
	std::vector<BannerInfo> banners;
	uint8_t bannerDelay = 5;
	std::vector<uint32_t> homeOffers;

	std::vector<Category> categoryVector;
	std::vector<Category> subCategoryVector;
	std::map<uint32_t, Offer> offersMap;

	bool loadOfferFromXml(Category* category, pugi::xml_node offer);
	bool loadStoreHome(pugi::xml_node homeNode);

	void addCategory(Category newCategory);
	void addOffer(uint32_t offerId, Offer offer);

	std::vector<std::string> offersDisableReason = {
		"You already own this outfit.",
		"You already own this mount.",
		"You can't buy XP Boost for today.",
		"You already have 3 slots released.",
		"You already have maximum of prey wildcards.",
		"You reached the maximum amount for this blessing.",
		"You reached the maximum amount for some blessing.",
		"You already have a pouch.",
		"You already have maximum of reward tokens.",
		"You already have charm expansion."
	};
};

class Category { // We're gonna use the same class for Category and Subcategory
public:
	Category(std::string name, std::string icon, bool rookgaard, States_t state = States_t::NONE) :
		categoryName(name), categoryIcon(icon), canRookgaardAcess(rookgaard), categoryState(state) { }

	std::string getCategoryName() const {
		return categoryName;
	}
	std::string getCategoryIcon() const {
		return categoryIcon;
	}
	States_t getCategoryState() const {
		return categoryState;
	}
	bool getRookgaardAcess() const {
		return canRookgaardAcess;
	}
	bool isSpecialCategory() const {
		return specialCategory;
	}

	const Category* getFirstSubCategory() const;
	std::vector<Category> getSubCategoriesVector() const;
	std::vector<Offer> getOffersVector() const;

private:
	friend class IOStore;

	std::string categoryName;
	std::string categoryIcon;
	bool canRookgaardAcess;
	States_t categoryState = States_t::NONE;
	bool specialCategory = false;

	// Used when Category class is a Category
	std::vector<Category> subCategories;

	// Used when Category class is a Subcategory or a "Special Category"
	std::vector<Offer> offers;

	void addSubCategory(Category newSubCategory);
	void addOffer(Offer newOffer);
	void setSpecialCategory(bool state) {
		specialCategory = state;
	}
};

class Offer {
public:
	Offer(std::string parentName, std::string name, std::string icon, uint32_t id, uint32_t price, OfferTypes_t type, States_t state, uint16_t count, uint16_t duration, CoinType_t coin, std::string description, OutfitIds outfitIds) :
		parentName(parentName), offerName(name), offerIcon(icon), offerId(id), offerPrice(price), offerType(type), offerState(state), offerCount(count), validUntil(duration), coinType(coin), offerDescription(description), outfitId(outfitIds) { }

	std::string getOfferName() const {
		return offerName;
	}
	std::string getOfferIcon() const {
		return offerIcon;
	}
	uint32_t getOfferId() const {
		return offerId;
	}
	uint32_t getOfferPrice() const {
		return offerPrice;
	}
	OfferTypes_t getOfferType() const {
		return offerType;
	}
	States_t getOfferState() const {
		return offerState;
	}
	uint16_t getOfferCount() const {
		return offerCount;
	}
	uint16_t getValidUntil() const {
		return validUntil;
	}
	CoinType_t getCoinType() const {
		return coinType;
	}
	std::string getOfferDescription() const {
		return offerDescription;
	}
	OutfitIds getOutfitIds() const {
		return outfitId;
	}
	std::string getParentName() const {
		return parentName;
	}
	ConverType_t getConverType() const;
	bool getUseConfigure() const;

private:
	// Mandatory
	std::string offerName;
	uint32_t offerId; // Any identifier (itemId, mountId, ...)
	uint32_t offerPrice;
	OfferTypes_t offerType = OfferTypes_t::NONE;

	// Optional
	std::string offerIcon;
	States_t offerState = States_t::NONE;
	uint16_t offerCount = 0; // Or charges
	uint16_t validUntil;
	CoinType_t coinType = CoinType_t::COIN;
	std::string offerDescription;
	OutfitIds outfitId;

	// Internal
	std::string parentName;
};

constexpr auto g_ioStore = &IOStore::getInstance;
#endif // SRC_IO_IO_STORE_HPP_