// // SuperTuxKart - a fun racing game with go-kart // Copyright (C) 2013-2015 Glenn De Jonghe // // 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 3 // 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. #ifndef HEADER_SERVER_HPP #define HEADER_SERVER_HPP /** * \defgroup onlinegroup Online * Represents a server that is joinable */ #include "race/race_manager.hpp" #include "utils/types.hpp" #include #include #include #include class Track; class XMLNode; class SocketAddress; /** * \ingroup online */ class Server { public: protected: /** The server name to be displayed. */ irr::core::stringw m_name; /** Name in lower case for comparisons. */ std::string m_lower_case_name; std::string m_server_owner_lower_case_name; std::string m_lower_case_player_names; /** We need to use full socket address structure instead of string to hold * it, because for local link address the scope id matters for * multicasting. */ std::unique_ptr m_ipv6_address; uint32_t m_server_id; uint32_t m_server_owner; /** The maximum number of players that the server supports */ int m_max_players; /** The number of players currently on the server */ int m_current_players; /** The public ip address and port of this server. */ std::unique_ptr m_address; /** This is the private port of the server. This is used if a WAN game * is started, but one client is discovered on the same LAN, so a direct * connection using the private port with a broadcast is possible. */ uint16_t m_private_port; unsigned m_server_mode; RaceManager::Difficulty m_difficulty; bool m_password_protected; /* WAN server only, show the owner name of server, can only be seen * for localhost or if you are friend with the server owner. */ core::stringw m_server_owner_name; /* WAN server only, distance based on IP latitude and longitude. */ float m_distance; /* WAN server only, true if hosted officially by stk team. */ bool m_official; bool m_supports_encrytion; bool m_game_started; bool m_ipv6_connection; bool m_reconnect_when_quit_lobby; std::vector > m_players; std::string m_current_track; std::string m_country_code; public: /** Initialises the object from an XML node. */ Server(const XMLNode& server_info); Server(unsigned server_id, const irr::core::stringw &name, int max_players, int current_players, unsigned difficulty, unsigned server_mode, const SocketAddress &address, bool password_protected, bool game_started, const std::string& current_track = ""); // ------------------------------------------------------------------------ virtual ~Server(); // ------------------------------------------------------------------------ /** Returns IPv4 address and port of this server. */ const SocketAddress& getAddress() const { return *m_address.get(); } // ------------------------------------------------------------------------ void setAddress(const SocketAddress& addr); // ------------------------------------------------------------------------ /** Returns the lower case name of the server. */ const std::string& getLowerCaseName() const { return m_lower_case_name; } // ------------------------------------------------------------------------ /** Returns the name of the server. */ const irr::core::stringw& getName() const { return m_name; } // ------------------------------------------------------------------------ /** Returns the ID of this server. */ const uint32_t getServerId() const { return m_server_id; } // ------------------------------------------------------------------------ /** Returns the user id in STK addon server of the server owner (WAN). */ const uint32_t getServerOwner() const { return m_server_owner; } // ------------------------------------------------------------------------ uint16_t getPrivatePort() const { return m_private_port; } // ------------------------------------------------------------------------ /** Returns the maximum number of players allowed on this server. */ const int getMaxPlayers() const { return m_max_players; } // ------------------------------------------------------------------------ /** Returns the number of currently connected players. */ const int getCurrentPlayers() const { return m_current_players; } // ------------------------------------------------------------------------ unsigned getServerMode() const { return m_server_mode; } // ------------------------------------------------------------------------ RaceManager::Difficulty getDifficulty() const { return m_difficulty; } // ------------------------------------------------------------------------ bool isPasswordProtected() const { return m_password_protected; } // ------------------------------------------------------------------------ const core::stringw& getServerOwnerName() const { return m_server_owner_name; } // ------------------------------------------------------------------------ const std::string& getServerOwnerLowerCaseName() const { return m_server_owner_lower_case_name; } // ------------------------------------------------------------------------ float getDistance() const { return m_distance; } // ------------------------------------------------------------------------ bool supportsEncryption() const { return m_supports_encrytion; } // ------------------------------------------------------------------------ bool isOfficial() const { return m_official; } // ------------------------------------------------------------------------ bool isGameStarted() const { return m_game_started; } // ------------------------------------------------------------------------ const std::vector >& getPlayers() const { return m_players; } // ------------------------------------------------------------------------ void setServerId(unsigned id) { m_server_id = id; } // ------------------------------------------------------------------------ void setPrivatePort(uint16_t port) { m_private_port = port; } // ------------------------------------------------------------------------ void setSupportsEncryption(bool val) { m_supports_encrytion = val; } // ------------------------------------------------------------------------ bool searchByName(const std::string& lower_case_word); // ------------------------------------------------------------------------ Track* getCurrentTrack() const; // ------------------------------------------------------------------------ const std::string& getCountryCode() const { return m_country_code; } // ------------------------------------------------------------------------ void setIPV6Connection(bool val) { if (!m_ipv6_address) m_ipv6_connection = false; else m_ipv6_connection = val; } // ------------------------------------------------------------------------ bool useIPV6Connection() const { return m_ipv6_connection; } // ------------------------------------------------------------------------ void setIPV6Address(const SocketAddress& addr); // ------------------------------------------------------------------------ SocketAddress* getIPV6Address() const { if (!m_ipv6_address) return NULL; return m_ipv6_address.get(); } // ------------------------------------------------------------------------ virtual void saveServer() const {} // ------------------------------------------------------------------------ void setIsPasswordProtected(bool password_protected) { m_password_protected = password_protected; } // ------------------------------------------------------------------------ bool reconnectWhenQuitLobby() const { return m_reconnect_when_quit_lobby; } // ------------------------------------------------------------------------ void setReconnectWhenQuitLobby(bool val) { m_reconnect_when_quit_lobby = val; } // ------------------------------------------------------------------------ std::string getBookmarkKey() const; }; // Server class UserDefinedServer : public Server { public: UserDefinedServer(const core::stringw& name, const SocketAddress& ipv4, bool password_protected = false) : Server(0, name, 0, 0, 0, 0, ipv4, password_protected, false) {} // ------------------------------------------------------------------------ virtual void saveServer() const; }; // UserDefinedServer #endif // HEADER_SERVER_HPP