OpenTTD Source: src/network/network_admin.h Source File

OpenTTD Source 13.2.1

network_admin.h
Go to the documentation of this file.
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
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;
21 typedef Pool<ServerNetworkAdminSocketHandler, AdminIndex, 2, MAX_ADMINS, PT_NADMIN> NetworkAdminSocketPool;
22 extern NetworkAdminSocketPool _networkadminsocket_pool;
23
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_EXTERNAL_CHAT(Packet *p) override;
33 NetworkRecvStatus Receive_ADMIN_RCON(Packet *p) override;
34 NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet *p) override;
35 NetworkRecvStatus Receive_ADMIN_PING(Packet *p) override;
36
37 NetworkRecvStatus SendProtocol();
38 NetworkRecvStatus SendPong(uint32 d1);
39 public:
40 AdminUpdateFrequency update_frequency[ADMIN_UPDATE_END];
41 std::chrono::steady_clock::time_point connect_time;
42 NetworkAddress address;
43
44 ServerNetworkAdminSocketHandler(SOCKET s);
45 ~ServerNetworkAdminSocketHandler();
46
47 NetworkRecvStatus SendError(NetworkErrorCode error);
48 NetworkRecvStatus SendWelcome();
49 NetworkRecvStatus SendNewGame();
50 NetworkRecvStatus SendShutdown();
51
52 NetworkRecvStatus SendDate();
53 NetworkRecvStatus SendClientJoin(ClientID client_id);
54 NetworkRecvStatus SendClientInfo(const NetworkClientSocket *cs, const NetworkClientInfo *ci);
55 NetworkRecvStatus SendClientUpdate(const NetworkClientInfo *ci);
56 NetworkRecvStatus SendClientQuit(ClientID client_id);
57 NetworkRecvStatus SendClientError(ClientID client_id, NetworkErrorCode error);
58 NetworkRecvStatus SendCompanyNew(CompanyID company_id);
59 NetworkRecvStatus SendCompanyInfo(const Company *c);
60 NetworkRecvStatus SendCompanyUpdate(const Company *c);
61 NetworkRecvStatus SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr);
62 NetworkRecvStatus SendCompanyEconomy();
63 NetworkRecvStatus SendCompanyStats();
64
65 NetworkRecvStatus SendChat(NetworkAction action, DestType desttype, ClientID client_id, const std::string &msg, int64 data);
66 NetworkRecvStatus SendRcon(uint16 colour, const std::string_view command);
67 NetworkRecvStatus SendConsole(const std::string_view origin, const std::string_view command);
68 NetworkRecvStatus SendGameScript(const std::string_view json);
69 NetworkRecvStatus SendCmdNames();
70 NetworkRecvStatus SendCmdLogging(ClientID client_id, const CommandPacket *cp);
71 NetworkRecvStatus SendRconEnd(const std::string_view command);
72
73 static void Send();
74 static void AcceptConnection(SOCKET s, const NetworkAddress &address);
75 static bool AllowConnection();
76 static void WelcomeAll();
77
82 static const char *GetName()
83 {
84 return "admin";
85 }
86
87 struct ServerNetworkAdminSocketHandlerFilter {
88 bool operator() (size_t index) { return ServerNetworkAdminSocketHandler::Get(index)->GetAdminStatus() == ADMIN_STATUS_ACTIVE; }
89 };
90
96 static Pool::IterateWrapperFiltered<ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter> IterateActive(size_t from = 0)
97 {
98 return Pool::IterateWrapperFiltered<ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter>(from, ServerNetworkAdminSocketHandlerFilter{});
99 }
100 };
101
102 void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client = false);
103 void NetworkAdminClientUpdate(const NetworkClientInfo *ci);
104 void NetworkAdminClientQuit(ClientID client_id);
105 void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code);
106 void NetworkAdminCompanyInfo(const Company *company, bool new_company);
107 void NetworkAdminCompanyUpdate(const Company *company);
108 void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr);
109
110 void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const std::string &msg, int64 data = 0, bool from_admin = false);
111 void NetworkAdminUpdate(AdminUpdateFrequency freq);
112 void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const std::string_view string);
113 void NetworkAdminConsole(const std::string_view origin, const std::string_view string);
114 void NetworkAdminGameScript(const std::string_view json);
115 void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp);
116
117 #endif /* NETWORK_ADMIN_H */
DestType
DestType
Destination of our chat messages.
Definition: network_type.h:89
ServerNetworkAdminSocketHandler::Receive_ADMIN_UPDATE_FREQUENCY
NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY(Packet *p) override
Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet): uint16 Upda...
Definition: network_admin.cpp:678
Pool::PoolItem<&_networkadminsocket_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
NetworkAdminConsole
void NetworkAdminConsole(const std::string_view origin, const std::string_view string)
Send console to the admin network (if they did opt in for the respective update).
Definition: network_admin.cpp:950
NetworkAdminClientInfo
void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client=false)
Notify the admin network of a new client (if they did opt in for the respective update).
Definition: network_admin.cpp:818
ServerNetworkAdminSocketHandler::SendError
NetworkRecvStatus SendError(NetworkErrorCode error)
Send an error to the admin.
Definition: network_admin.cpp:134
ServerNetworkAdminSocketHandler::SendRconEnd
NetworkRecvStatus SendRconEnd(const std::string_view command)
Send a notification indicating the rcon command has completed.
Definition: network_admin.cpp:476
ServerNetworkAdminSocketHandler::SendCompanyEconomy
NetworkRecvStatus SendCompanyEconomy()
Send economic information of all companies.
Definition: network_admin.cpp:389
ServerNetworkAdminSocketHandler::SendRcon
NetworkRecvStatus SendRcon(uint16 colour, const std::string_view command)
Send the reply of an rcon command.
Definition: network_admin.cpp:491
ServerNetworkAdminSocketHandler::update_frequency
AdminUpdateFrequency update_frequency[ADMIN_UPDATE_END]
Admin requested update intervals.
Definition: network_admin.h:40
NetworkAction
NetworkAction
Actions that can be used for NetworkTextMessage.
Definition: network_type.h:99
Pool::PoolItem<&_networkadminsocket_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
ServerNetworkAdminSocketHandler::WelcomeAll
static void WelcomeAll()
Send a Welcome packet to all connected admins.
Definition: network_admin.cpp:991
Pool::IterateWrapperFiltered
Definition: pool_type.hpp:220
ServerNetworkAdminSocketHandler::Receive_ADMIN_JOIN
NetworkRecvStatus Receive_ADMIN_JOIN(Packet *p) override
Join the admin network: string Password the server is expecting for this network.
Definition: network_admin.cpp:645
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:253
tcp_listen.h
ServerNetworkAdminSocketHandler::IterateActive
static Pool::IterateWrapperFiltered< ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter > IterateActive(size_t from=0)
Returns an iterable ensemble of all active admin sockets.
Definition: network_admin.h:96
ServerNetworkAdminSocketHandler::SendCompanyUpdate
NetworkRecvStatus SendCompanyUpdate(const Company *c)
Send an update about a company.
Definition: network_admin.cpp:349
NetworkAdminCompanyInfo
void NetworkAdminCompanyInfo(const Company *company, bool new_company)
Notify the admin network of company details.
Definition: network_admin.cpp:875
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
ServerNetworkAdminSocketHandler::SendCompanyInfo
NetworkRecvStatus SendCompanyInfo(const Company *c)
Send the admin some information about a company.
Definition: network_admin.cpp:320
ServerNetworkAdminSocketHandler::address
NetworkAddress address
Address of the admin.
Definition: network_admin.h:42
ServerNetworkAdminSocketHandler::Send
static void Send()
Send the packets for the server sockets.
Definition: network_admin.cpp:101
NetworkAdminCompanyRemove
void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
Notify the admin network of a company to be removed (including the reason why).
Definition: network_admin.cpp:912
TCPListenHandler
Template for TCP listeners.
Definition: tcp_listen.h:28
NetworkAdminGameScript
void NetworkAdminGameScript(const std::string_view json)
Send GameScript JSON to the admin network (if they did opt in for the respective update).
Definition: network_admin.cpp:963
ServerNetworkAdminSocketHandler::SendShutdown
NetworkRecvStatus SendShutdown()
Tell the admin we're shutting down.
Definition: network_admin.cpp:198
NetworkAdminClientQuit
void NetworkAdminClientQuit(ClientID client_id)
Notify the admin network that a client quit (if they have opt in for the respective update).
Definition: network_admin.cpp:847
ServerNetworkAdminSocketHandler::connect_time
std::chrono::steady_clock::time_point connect_time
Time of connection.
Definition: network_admin.h:41
CommandPacket
Everything we need to know about a command to be able to execute it.
Definition: network_internal.h:109
ServerNetworkAdminSocketHandler::SendConsole
NetworkRecvStatus SendConsole(const std::string_view origin, const std::string_view command)
Send console output of other clients.
Definition: network_admin.cpp:544
NetworkServerSendAdminRcon
void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const std::string_view string)
Pass the rcon reply to the admin.
Definition: network_admin.cpp:940
ServerNetworkAdminSocketHandler::SendCompanyRemove
NetworkRecvStatus SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
Tell the admin that a company got removed.
Definition: network_admin.cpp:376
ClientID
ClientID
'Unique' identifier to be given to clients
Definition: network_type.h:47
NetworkAdminSocketHandler
Main socket handler for admin related connections.
Definition: tcp_admin.h:112
NetworkAdminSocketPool
Pool< ServerNetworkAdminSocketHandler, AdminIndex, 2, MAX_ADMINS, PT_NADMIN > NetworkAdminSocketPool
Pool with all admin connections.
Definition: network_admin.h:19
ServerNetworkAdminSocketHandler::AllowConnection
static bool AllowConnection()
Whether a connection is allowed or not at this moment.
Definition: network_admin.cpp:90
ServerNetworkAdminSocketHandler::SendWelcome
NetworkRecvStatus SendWelcome()
Send a welcome message to the admin.
Definition: network_admin.cpp:169
ServerNetworkAdminSocketHandler::SendGameScript
NetworkRecvStatus SendGameScript(const std::string_view json)
Send GameScript JSON output.
Definition: network_admin.cpp:565
_networkadminsocket_pool
NetworkAdminSocketPool _networkadminsocket_pool
The pool with sockets/clients.
NetworkAdminClientUpdate
void NetworkAdminClientUpdate(const NetworkClientInfo *ci)
Notify the admin network of a client update (if they did opt in for the respective update).
Definition: network_admin.cpp:834
_redirect_console_to_admin
AdminIndex _redirect_console_to_admin
Redirection of the (remote) console to the admin.
Definition: network_admin.cpp:31
NetworkAdminCompanyUpdate
void NetworkAdminCompanyUpdate(const Company *company)
Notify the admin network of company updates.
Definition: network_admin.cpp:896
ServerNetworkAdminSocketHandler::~ServerNetworkAdminSocketHandler
~ServerNetworkAdminSocketHandler()
Clear everything related to this admin.
Definition: network_admin.cpp:74
ServerNetworkAdminSocketHandler::SendClientQuit
NetworkRecvStatus SendClientQuit(ClientID client_id)
Tell the admin that a client quit.
Definition: network_admin.cpp:276
AdminCompanyRemoveReason
AdminCompanyRemoveReason
Reasons for removing a company - communicated to admins.
Definition: tcp_admin.h:103
NetworkAdminClientError
void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code)
Notify the admin network of a client error (if they have opt in for the respective update).
Definition: network_admin.cpp:861
Packet
Internal entity of a packet.
Definition: packet.h:44
ServerNetworkAdminSocketHandler::SendCmdNames
NetworkRecvStatus SendCmdNames()
Send the names of the commands.
Definition: network_admin.cpp:592
ServerNetworkAdminSocketHandler::SendNewGame
NetworkRecvStatus SendNewGame()
Tell the admin we started a new game.
Definition: network_admin.cpp:190
NetworkAddress
Wrapper for (un)resolved network addresses; there's no reason to transform a numeric IP to a string a...
Definition: address.h:30
ServerNetworkAdminSocketHandler::SendDate
NetworkRecvStatus SendDate()
Tell the admin the date.
Definition: network_admin.cpp:206
ServerNetworkAdminSocketHandler::SendCompanyNew
NetworkRecvStatus SendCompanyNew(CompanyID company_id)
Tell the admin that a new company was founded.
Definition: network_admin.cpp:306
Pool
Base class for all pools.
Definition: pool_type.hpp:81
ServerNetworkAdminSocketHandler::Receive_ADMIN_QUIT
NetworkRecvStatus Receive_ADMIN_QUIT(Packet *p) override
Notification to the server that this admin is quitting.
Definition: network_admin.cpp:672
ServerNetworkAdminSocketHandler::SendPong
NetworkRecvStatus SendPong(uint32 d1)
Send ping-reply (pong) to admin.
Definition: network_admin.cpp:581
ServerNetworkAdminSocketHandler::SendChat
NetworkRecvStatus SendChat(NetworkAction action, DestType desttype, ClientID client_id, const std::string &msg, int64 data)
Send a chat message.
Definition: network_admin.cpp:458
ServerNetworkAdminSocketHandler::ServerNetworkAdminSocketHandler
ServerNetworkAdminSocketHandler(SOCKET s)
Sanity check.
Definition: network_admin.cpp:64
NetworkAdminUpdate
void NetworkAdminUpdate(AdminUpdateFrequency freq)
Send (push) updates to the admin network as they have registered for these updates.
Definition: network_admin.cpp:1002
ServerNetworkAdminSocketHandler
Class for handling the server side of the game connection.
Definition: network_admin.h:25
NetworkRecvStatus
NetworkRecvStatus
Status of a network client; reasons why a client has quit.
Definition: core.h:22
ServerNetworkAdminSocketHandler::Receive_ADMIN_POLL
NetworkRecvStatus Receive_ADMIN_POLL(Packet *p) override
Poll the server for certain updates, an invalid poll (e.g.
Definition: network_admin.cpp:698
ServerNetworkAdminSocketHandler::SendClientInfo
NetworkRecvStatus SendClientInfo(const NetworkClientSocket *cs, const NetworkClientInfo *ci)
Send an initial set of data from some client's information.
Definition: network_admin.cpp:235
ADMIN_STATUS_ACTIVE
@ ADMIN_STATUS_ACTIVE
The admin is active.
Definition: tcp_admin.h:71
ServerNetworkAdminSocketHandler::SendProtocol
NetworkRecvStatus SendProtocol()
Send the protocol version to the admin.
Definition: network_admin.cpp:149
network_internal.h
ServerNetworkAdminSocketHandler::Receive_ADMIN_PING
NetworkRecvStatus Receive_ADMIN_PING(Packet *p) override
Ping the server, requiring the server to reply with a pong packet.
Definition: network_admin.cpp:528
tcp_admin.h
ServerNetworkAdminSocketHandler::AcceptConnection
static void AcceptConnection(SOCKET s, const NetworkAddress &address)
Handle the acception of a connection.
Definition: network_admin.cpp:120
ServerNetworkAdminSocketHandler::GetName
static const char * GetName()
Get the name used by the listener.
Definition: network_admin.h:82
ServerNetworkAdminSocketHandler::SendClientUpdate
NetworkRecvStatus SendClientUpdate(const NetworkClientInfo *ci)
Send an update for some client's information.
Definition: network_admin.cpp:259
error
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Definition: openttd.cpp:134
AdminIndex
uint8 AdminIndex
Indices into the admin tables.
Definition: network_type.h:57
ServerNetworkAdminSocketHandler::Receive_ADMIN_EXTERNAL_CHAT
NetworkRecvStatus Receive_ADMIN_EXTERNAL_CHAT(Packet *p) override
Send chat from the external source: string Name of the source this message came from.
Definition: network_admin.cpp:790
NetworkAdminChat
void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const std::string &msg, int64 data=0, bool from_admin=false)
Send chat to the admin network (if they did opt in for the respective update).
Definition: network_admin.cpp:923
ServerNetworkAdminSocketHandler::Receive_ADMIN_RCON
NetworkRecvStatus Receive_ADMIN_RCON(Packet *p) override
Execute a command on the servers console: string Command to be executed.
Definition: network_admin.cpp:502
ServerNetworkAdminSocketHandler::Receive_ADMIN_CHAT
NetworkRecvStatus Receive_ADMIN_CHAT(Packet *p) override
Send chat as the server: uint8 Action such as NETWORK_ACTION_CHAT_CLIENT (see NetworkAction).
Definition: network_admin.cpp:764
ServerNetworkAdminSocketHandler::Receive_ADMIN_GAMESCRIPT
NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet *p) override
Send a JSON string to the current active GameScript.
Definition: network_admin.cpp:516
ServerNetworkAdminSocketHandler::SendCompanyStats
NetworkRecvStatus SendCompanyStats()
Send statistics about the companies.
Definition: network_admin.cpp:423
ADMIN_UPDATE_END
@ ADMIN_UPDATE_END
Must ALWAYS be on the end of this list!! (period)
Definition: tcp_admin.h:87
Company
Definition: company_base.h:117
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:234
AdminUpdateFrequency
AdminUpdateFrequency
Update frequencies an admin can register.
Definition: tcp_admin.h:91
ServerNetworkAdminSocketHandler::ServerNetworkAdminSocketHandlerFilter
Definition: network_admin.h:87
ServerNetworkAdminSocketHandler::SendClientJoin
NetworkRecvStatus SendClientJoin(ClientID client_id)
Tell the admin that a client joined.
Definition: network_admin.cpp:220
NetworkErrorCode
NetworkErrorCode
The error codes we send around in the protocols.
Definition: network_type.h:119
NetworkClientInfo
Container for all information known about a client.
Definition: network_base.h:24
ServerNetworkAdminSocketHandler::SendClientError
NetworkRecvStatus SendClientError(ClientID client_id, NetworkErrorCode error)
Tell the admin that a client made an error.
Definition: network_admin.cpp:291
NetworkAdminCmdLogging
void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp)
Distribute CommandPacket details over the admin network for logging purposes.
Definition: network_admin.cpp:977
ServerNetworkAdminSocketHandler::SendCmdLogging
NetworkRecvStatus SendCmdLogging(ClientID client_id, const CommandPacket *cp)
Send a command for logging purposes.
Definition: network_admin.cpp:626