network_admin.h

Go to the documentation of this file.

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

 
#ifndef NETWORK_ADMIN_H
#define NETWORK_ADMIN_H
 
#include "network_internal.h"
#include "core/tcp_listen.h"
#include "core/tcp_admin.h"
 
extern AdminID _redirect_console_to_admin;
 
class ServerNetworkAdminSocketHandler;
using NetworkAdminSocketPool = Pool<ServerNetworkAdminSocketHandler, AdminID, 2, PoolType::NetworkAdmin>;
extern NetworkAdminSocketPool _networkadminsocket_pool;

class ServerNetworkAdminSocketHandler : public NetworkAdminSocketPool::PoolItem<&_networkadminsocket_pool>, public NetworkAdminSocketHandler, public TCPListenHandler<ServerNetworkAdminSocketHandler, PacketAdminType, PacketAdminType::ServerFull, PacketAdminType::ServerBanned> {
private:
  std::unique_ptr<NetworkAuthenticationServerHandler> authentication_handler = nullptr; 
protected:
  NetworkRecvStatus ReceiveAdminJoin(Packet &p) override;
  NetworkRecvStatus ReceiveAdminQuit(Packet &p) override;
  NetworkRecvStatus ReceiveAdminUpdateFrequency(Packet &p) override;
  NetworkRecvStatus ReceiveAdminPoll(Packet &p) override;
  NetworkRecvStatus ReceiveAdminChat(Packet &p) override;
  NetworkRecvStatus ReceiveAdminExternalChat(Packet &p) override;
  NetworkRecvStatus ReceiveAdminRemoteConsoleCommand(Packet &p) override;
  NetworkRecvStatus ReceiveAdminGameScript(Packet &p) override;
  NetworkRecvStatus ReceiveAdminPing(Packet &p) override;
  NetworkRecvStatus ReceiveAdminJoinSecure(Packet &p) override;
  NetworkRecvStatus ReceiveAdminAuthenticationResponse(Packet &p) override;
 
  NetworkRecvStatus SendProtocol();
  NetworkRecvStatus SendPong(uint32_t d1);
  NetworkRecvStatus SendAuthRequest();
  NetworkRecvStatus SendEnableEncryption();
public:
  std::array<AdminUpdateFrequencies, ADMIN_UPDATE_END> update_frequency{}; 
  std::chrono::steady_clock::time_point connect_time{}; 
  NetworkAddress address{}; 
 
  ServerNetworkAdminSocketHandler(AdminID index, SOCKET s);
  ~ServerNetworkAdminSocketHandler() override;
 
  NetworkRecvStatus SendError(NetworkErrorCode error);
  NetworkRecvStatus SendWelcome();
  NetworkRecvStatus SendNewGame();
  NetworkRecvStatus SendShutdown();
 
  NetworkRecvStatus SendDate();
  NetworkRecvStatus SendClientJoin(ClientID client_id);
  NetworkRecvStatus SendClientInfo(const NetworkClientSocket *cs, const NetworkClientInfo *ci);
  NetworkRecvStatus SendClientUpdate(const NetworkClientInfo *ci);
  NetworkRecvStatus SendClientQuit(ClientID client_id);
  NetworkRecvStatus SendClientError(ClientID client_id, NetworkErrorCode error);
  NetworkRecvStatus SendCompanyNew(CompanyID company_id);
  NetworkRecvStatus SendCompanyInfo(const Company *c);
  NetworkRecvStatus SendCompanyUpdate(const Company *c);
  NetworkRecvStatus SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr);
  NetworkRecvStatus SendCompanyEconomy();
  NetworkRecvStatus SendCompanyStats();
 
  NetworkRecvStatus SendChat(NetworkAction action, NetworkChatDestinationType desttype, ClientID client_id, std::string_view msg, int64_t data);
  NetworkRecvStatus SendRcon(uint16_t colour, std::string_view command);
  NetworkRecvStatus SendConsole(std::string_view origin, std::string_view command);
  NetworkRecvStatus SendGameScript(std::string_view json);
  NetworkRecvStatus SendCmdNames();
  NetworkRecvStatus SendCmdLogging(ClientID client_id, const CommandPacket &cp);
  NetworkRecvStatus SendRconEnd(std::string_view command);
 
  static void Send();
  static void AcceptConnection(SOCKET s, const NetworkAddress &address);
  static bool AllowConnection();
  static void WelcomeAll();

  static std::string_view GetName()
  {
    return "admin";
  }

  struct ServerNetworkAdminSocketHandlerFilter {
    bool operator() (size_t index) { return ServerNetworkAdminSocketHandler::Get(index)->GetAdminStatus() == ADMIN_STATUS_ACTIVE; }
  };

  static Pool::IterateWrapperFiltered<ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter> IterateActive(size_t from = 0)
  {
    return Pool::IterateWrapperFiltered<ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter>(from, ServerNetworkAdminSocketHandlerFilter{});
  }
};
 
void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client = false);
void NetworkAdminClientUpdate(const NetworkClientInfo *ci);
void NetworkAdminClientQuit(ClientID client_id);
void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code);
void NetworkAdminCompanyNew(const Company *company);
void NetworkAdminCompanyUpdate(const Company *company);
void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr);
 
void NetworkAdminChat(NetworkAction action, NetworkChatDestinationType desttype, ClientID client_id, std::string_view msg, int64_t data = 0, bool from_admin = false);
void NetworkAdminUpdate(AdminUpdateFrequency freq);
void NetworkServerSendAdminRcon(AdminID admin_index, TextColour colour_code, std::string_view string);
void NetworkAdminConsole(std::string_view origin, std::string_view string);
void NetworkAdminGameScript(std::string_view json);
void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket &cp);
 
#endif /* NETWORK_ADMIN_H */