src/network/network_admin.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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 <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file network_admin.h Server part of the admin network protocol. */
   9
  10 #ifndef NETWORK_ADMIN_H
  11 #define NETWORK_ADMIN_H
  12
  13 #include "network_internal.h"
  14 #include "core/tcp_listen.h"
  15 #include "core/tcp_admin.h"
  16
  17 extern AdminIndex _redirect_console_to_admin;
  18
  19 class ServerNetworkAdminSocketHandler;
  20 /** Pool with all admin connections. */
  21 typedef Pool<ServerNetworkAdminSocketHandler, AdminIndex, 2, MAX_ADMINS, PT_NADMIN> NetworkAdminSocketPool;
  22 extern NetworkAdminSocketPool _networkadminsocket_pool;
  23
  24 /** Class for handling the server side of the game connection. */
  25 class ServerNetworkAdminSocketHandler : public NetworkAdminSocketPool::PoolItem<&_networkadminsocket_pool>, public NetworkAdminSocketHandler, public TCPListenHandler<ServerNetworkAdminSocketHandler, ADMIN_PACKET_SERVER_FULL, ADMIN_PACKET_SERVER_BANNED> {
  26 protected:
  27         NetworkRecvStatus Receive_ADMIN_JOIN(Packet *p) override;
  28         NetworkRecvStatus Receive_ADMIN_QUIT(Packet *p) override;
  29         NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY(Packet *p) override;
  30         NetworkRecvStatus Receive_ADMIN_POLL(Packet *p) override;
  31         NetworkRecvStatus Receive_ADMIN_CHAT(Packet *p) override;
  32         NetworkRecvStatus Receive_ADMIN_RCON(Packet *p) override;
  33         NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet *p) override;
  34         NetworkRecvStatus Receive_ADMIN_PING(Packet *p) override;
  35
  36         NetworkRecvStatus SendProtocol();
  37         NetworkRecvStatus SendPong(uint32 d1);
  38 public:
  39         AdminUpdateFrequency update_frequency[ADMIN_UPDATE_END]; ///< Admin requested update intervals.
  40         std::chrono::steady_clock::time_point connect_time;      ///< Time of connection.
  41         NetworkAddress address;                                  ///< Address of the admin.
  42
  43         ServerNetworkAdminSocketHandler(SOCKET s);
  44         ~ServerNetworkAdminSocketHandler();
  45
  46         NetworkRecvStatus SendError(NetworkErrorCode error);
  47         NetworkRecvStatus SendWelcome();
  48         NetworkRecvStatus SendNewGame();
  49         NetworkRecvStatus SendShutdown();
  50
  51         NetworkRecvStatus SendDate();
  52         NetworkRecvStatus SendClientJoin(ClientID client_id);
  53         NetworkRecvStatus SendClientInfo(const NetworkClientSocket *cs, const NetworkClientInfo *ci);
  54         NetworkRecvStatus SendClientUpdate(const NetworkClientInfo *ci);
  55         NetworkRecvStatus SendClientQuit(ClientID client_id);
  56         NetworkRecvStatus SendClientError(ClientID client_id, NetworkErrorCode error);
  57         NetworkRecvStatus SendCompanyNew(CompanyID company_id);
  58         NetworkRecvStatus SendCompanyInfo(const Company *c);
  59         NetworkRecvStatus SendCompanyUpdate(const Company *c);
  60         NetworkRecvStatus SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr);
  61         NetworkRecvStatus SendCompanyEconomy();
  62         NetworkRecvStatus SendCompanyStats();
  63
  64         NetworkRecvStatus SendChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data);
  65         NetworkRecvStatus SendRcon(uint16 colour, const char *command);
  66         NetworkRecvStatus SendConsole(const char *origin, const char *command);
  67         NetworkRecvStatus SendGameScript(const char *json);
  68         NetworkRecvStatus SendCmdNames();
  69         NetworkRecvStatus SendCmdLogging(ClientID client_id, const CommandPacket *cp);
  70         NetworkRecvStatus SendRconEnd(const char *command);
  71
  72         static void Send();
  73         static void AcceptConnection(SOCKET s, const NetworkAddress &address);
  74         static bool AllowConnection();
  75         static void WelcomeAll();
  76
  77         /**
  78          * Get the name used by the listener.
  79          * @return the name to show in debug logs and the like.
  80          */
  81         static const char *GetName()
  82         {
  83                 return "admin";
  84         }
  85
  86         struct ServerNetworkAdminSocketHandlerFilter {
  87                 bool operator() (size_t index) { return ServerNetworkAdminSocketHandler::Get(index)->GetAdminStatus() == ADMIN_STATUS_ACTIVE; }
  88         };
  89
  90         /**
  91          * Returns an iterable ensemble of all active admin sockets
  92          * @param from index of the first socket to consider
  93          * @return an iterable ensemble of all active admin sockets
  94          */
  95         static Pool::IterateWrapperFiltered<ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter> IterateActive(size_t from = 0)
  96         {
  97                 return Pool::IterateWrapperFiltered<ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter>(from, ServerNetworkAdminSocketHandlerFilter{});
  98         }
  99 };
 100
 101 void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client = false);
 102 void NetworkAdminClientUpdate(const NetworkClientInfo *ci);
 103 void NetworkAdminClientQuit(ClientID client_id);
 104 void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code);
 105 void NetworkAdminCompanyInfo(const Company *company, bool new_company);
 106 void NetworkAdminCompanyUpdate(const Company *company);
 107 void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr);
 108
 109 void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data = 0, bool from_admin = false);
 110 void NetworkAdminUpdate(AdminUpdateFrequency freq);
 111 void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const char *string);
 112 void NetworkAdminConsole(const char *origin, const char *string);
 113 void NetworkAdminGameScript(const char *json);
 114 void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp);
 115
 116 #endif /* NETWORK_ADMIN_H */