DataSource.hpp

/**
 * Alicia Server - dedicated server software
 * Copyright (C) 2024 Story Of Alicia
 *
 * 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 of the License, 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.
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **/

#ifndef DATASOURCE_HPP
#define DATASOURCE_HPP

#include "libserver/data/DataDefinitions.hpp"
#include "server/Config.hpp"

#include <string_view>

namespace server
{

//! A class managing a data source.
class DataSource
{
public:
  //! Default destructor.
  virtual ~DataSource() = default;

  //! Creates the user in the data source.
  //! @param user User to ccreate.
  virtual void CreateUser(data::User& user) = 0;
  //! Retrieves the user from the data source.
  //! @param name Name of the user.
  //! @param user User to retrieve.
  virtual void RetrieveUser(const std::string_view& name, data::User& user) = 0;
  //! Stores the user on the data source.
  //! @param name Name of the user.
  //! @param user User to store.
  virtual void StoreUser(const std::string_view& name, const data::User& user) = 0;
  //! Returns whether the user name is unique.
  //! @return `true` if the user name is unique, otherwise returns `false`.
  virtual bool IsUserNameUnique(const std::string_view& name) = 0;

  //! Creates the infraction in the data source.
  //! @param infraction Infraction to create.
  virtual void CreateInfraction(data::Infraction& infraction) = 0;
  //! Retrieves the infraction from the data source.
  //! @param uid UID of the infraction.
  //! @param infraction Infraction to retrieve.
  virtual void RetrieveInfraction(data::Uid uid, data::Infraction& infraction) = 0;
  //! Stores the infraction on the data source.
  //! @param uid UID of the infraction.
  //! @param infraction Infraction to store.
  virtual void StoreInfraction(data::Uid uid, const data::Infraction& infraction) = 0;
  //! Deletes the infraction from the data source.
  //! @param uid UID of the infraction.
  virtual void DeleteInfraction(data::Uid uid) = 0;

  //! Creates the character in the data source.
  //! @param character Character to create.
  virtual void CreateCharacter(data::Character& character) = 0;
  //! Retrieves the user from the data source.
  //! @param uid UID of the character.
  //! @param character Character to retrieve.
  virtual void RetrieveCharacter(data::Uid uid, data::Character& character) = 0;
  //! Stores the character on the data source.
  //! @param uid UID of the character.
  //! @param character Character to store.
  virtual void StoreCharacter(data::Uid uid, const data::Character& character) = 0;
  //! Deletes the character from the data source.
  //! @param uid UID of the character.
  virtual void DeleteCharacter(data::Uid uid) = 0;
  //! Retrieves the character by character name from the data source.
  //! @param name Name of the character.
  //! @return `data::InvalidUid` if character by that name does not exist, otherwise returns `data::Uid` of the character.
  virtual data::Uid RetrieveCharacterUidByName(const std::string_view& name) = 0;
  //! Returns whether the character name is unique.
  //! @return `server::data::InvalidUid` if the character name is unique, otherwise returns the existing character UID.
  virtual bool IsCharacterNameUnique(const std::string_view& name) = 0;

  //! Creates the horse in the data source.
  //! @param horse Horse to create.
  virtual void CreateHorse(data::Horse& horse) = 0;
  //! Retrieves the horse from the data source.
  //! @param uid UID of the horse.
  //! @param horse Horse to retrieve.
  virtual void RetrieveHorse(data::Uid uid, data::Horse& horse) = 0;
  //! Stores the horse on the data source.
  //! @param uid UID of the horse.
  //! @param horse Horse to store.
  virtual void StoreHorse(data::Uid uid, const data::Horse& horse) = 0;
  //! Deletes the horse from the data source.
  //! @param uid UID of the horse.
  virtual void DeleteHorse(data::Uid uid) = 0;

  //! Creates the item in the data source.
  //! @param item Item to create.
  virtual void CreateItem(data::Item& item) = 0;
  //! Retrieves the item from the data source.
  //! @param uid UID of the item.
  //! @param item Item to retrieve.
  virtual void RetrieveItem(data::Uid uid, data::Item& item) = 0;
  //! Stores the item on the data source.
  //! @param uid UID of the item.
  //! @param item Item to store.
  virtual void StoreItem(data::Uid uid, const data::Item& item) = 0;
  //! Deletes the item from the data source.
  //! @param uid UID of the item.
  virtual void DeleteItem(data::Uid uid) = 0;

  //! Creates the storage item in the data source.
  //! @param storageItem Storage item to create.
  virtual void CreateStorageItem(data::StorageItem& storageItem) = 0;
  //! Retrieves the storage item from the data source.
  //! @param uid UID of the storage item.
  //! @param storageItem Storage item to retrieve.
  virtual void RetrieveStorageItem(data::Uid uid, data::StorageItem& storageItem) = 0;
  //! Stores the storage item on the data source.
  //! @param uid UID of the storage item.
  //! @param storageItem Stored item to store.
  virtual void StoreStorageItem(data::Uid uid, const data::StorageItem& storageItem) = 0;
  //! Deletes the storage item from the data source.
  //! @param uid UID of the storage item.
  virtual void DeleteStorageItem(data::Uid uid) = 0;

  //! Creates the egg in the data source.
  //! @param egg Egg to create.
  virtual void CreateEgg(data::Egg& egg) = 0;
  //! Retrieves the egg from the data source.
  //! @param uid UID of the egg.
  //! @param egg Egg to retrieve.
  virtual void RetrieveEgg(data::Uid uid, data::Egg& egg) = 0;
  //! Stores the egg on the data source.
  //! @param uid UID of the egg.
  //! @param egg Egg to store.
  virtual void StoreEgg(data::Uid uid, const data::Egg& egg) = 0;
  //! Deletes the egg from the data source.
  //! @param uid UID of the egg.
  virtual void DeleteEgg(data::Uid uid) = 0;

  //! Creates the pet in the data source.
  //! @param pet Pet to create.
  virtual void CreatePet(data::Pet& pet) = 0;
  //! Retrieves the pet from the data source.
  //! @param uid UID of the pet.
  //! @param pet Pet to retrieve.
  virtual void RetrievePet(data::Uid uid, data::Pet& pet) = 0;
  //! Stores the pet on the data source.
  //! @param uid UID of the pet.
  //! @param pet Pet to store.
  virtual void StorePet(data::Uid uid, const data::Pet& pet) = 0;
  //! Deletes the pet from the data source.
  //! @param uid UID of the pet.
  virtual void DeletePet(data::Uid uid) = 0;

  //! Creates the housing in the data source.
  //! @param housing Housing to create.
  virtual void CreateHousing(data::Housing& housing) = 0;
  //! Retrieves the housing from the data source.
  //! @param uid UID of the housing.
  //! @param housing Housing to retrieve.
  virtual void RetrieveHousing(data::Uid uid, data::Housing& housing) = 0;
  //! Stores the housing on the data source.
  //! @param uid UID of the housing.
  //! @param housing Housing to store.
  virtual void StoreHousing(data::Uid uid, const data::Housing& housing) = 0;
  //! Deletes the housing from the data source.
  //! @param uid UID of the housing.
  virtual void DeleteHousing(data::Uid uid) = 0;

  //! Creates the guild in the data source.
  //! @param guild Guild to create.
  virtual void CreateGuild(data::Guild& guild) = 0;
  //! Retrieves the guild from the data source.
  //! @param uid UID of the guild.
  //! @param guild Guild to retrieve.
  virtual void RetrieveGuild(data::Uid uid, data::Guild& guild) = 0;
  //! Stores the guild on the data source.
  //! @param uid UID of the guild.
  //! @param guild Guild to store.
  virtual void StoreGuild(data::Uid uid, const data::Guild& guild) = 0;
  //! Deletes the guild from the data source.
  //! @param uid UID of the guild.
  virtual void DeleteGuild(data::Uid uid) = 0;
  //! Returns whether the guild name is unique.
  //! @return `true` if the guild name is unique, otherwise returns `false`.
  virtual bool IsGuildNameUnique(const std::string_view& name) = 0;

  //! Creates the settings in the data source.
  //! @param settings Settings to create.
  virtual void CreateSettings(data::Settings& settings) = 0;
  //! Retrieves the settings from the data source.
  //! @param uid UID of the settings.
  virtual void RetrieveSettings(data::Uid uid, data::Settings& settings) = 0;
  //! Stores the settings on the data source.
  //! @param uid UID of the settings.
  //! @param settings Settings to store.
  virtual void StoreSettings(data::Uid uid, const data::Settings& settings) = 0;
  //! Deletes the settings from the data source.
  //! @param uid UID of the settings.
  virtual void DeleteSettings(data::Uid uid) = 0;

  //! Creates the daily quest group in the data source.
  //! @param group DailyQuestGroup to create.
  virtual void CreateDailyQuestGroup(data::DailyQuestGroup& group) = 0;
  //! Retrieves the daily quest group from the data source.
  //! @param uid UID of the daily quest group.
  virtual void RetrieveDailyQuestGroup(data::Uid uid, data::DailyQuestGroup& group) = 0;
  //! Stores the daily quest group on the data source.
  //! @param uid UID of the daily quest group.
  //! @param group DailyQuestGroup to store.
  virtual void StoreDailyQuestGroup(data::Uid uid, const data::DailyQuestGroup& group) = 0;
  //! Deletes the daily quest group from the data source.
  //! @param uid UID of the daily quest group.
  virtual void DeleteDailyQuestGroup(data::Uid uid) = 0;
  
  //! Creates the mail in the data source.
  //! @param mail Mail to create.
  virtual void CreateMail(data::Mail& mail) = 0;
  //! Retrieves the mail from the data source.
  //! @param uid UID of the mail.
  virtual void RetrieveMail(data::Uid uid, data::Mail& mail) = 0;
  //! Stores the mail on the data source.
  //! @param uid UID of the mail.
  //! @param mail Mail to store.
  virtual void StoreMail(data::Uid uid, const data::Mail& mail) = 0;
  //! Deletes the mail from the data source.
  //! @param uid UID of the mail.
  virtual void DeleteMail(data::Uid uid) = 0;

  //! Creates the quest in the data source.
  //! @param quest Quest to create.
  virtual void CreateQuest(data::Quest& quest) = 0;
  //! Retrieves the quest from the data source.
  //! @param uid UID of the quest.
  //! @param quest Quest to retrieve.
  virtual void RetrieveQuest(data::Uid uid, data::Quest& quest) = 0;
  //! Stores the quest on the data source.
  //! @param uid UID of the quest.
  //! @param quest Quest to store.
  virtual void StoreQuest(data::Uid uid, const data::Quest& quest) = 0;
  //! Deletes the quest from the data source.
  //! @param uid UID of the quest.
  virtual void DeleteQuest(data::Uid uid) = 0;

  //! Creates the stallion in the data source.
  //! @param stallion Stallion to create.
  virtual void CreateStallion(data::Stallion& stallion) = 0;
  //! Retrieves the stallion from the data source.
  //! @param uid UID of the stallion.
  //! @param stallion Stallion to retrieve.
  virtual void RetrieveStallion(data::Uid uid, data::Stallion& stallion) = 0;
  //! Stores the stallion on the data source.
  //! @param uid UID of the stallion.
  //! @param stallion Stallion to store.
  virtual void StoreStallion(data::Uid uid, const data::Stallion& stallion) = 0;
  //! Deletes the stallion from the data source.
  //! @param uid UID of the stallion.
  virtual void DeleteStallion(data::Uid uid) = 0;
  //! Lists all registered stallion UIDs from the data source.
  //! @returns Vector of stallion UIDs.
  virtual std::vector<data::Uid> ListRegisteredStallions() = 0;
};

} // namespace server

#endif // DATASOURCE_HPP