network_admin.cpp

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 <http://www.gnu.org/licenses/>.
 */
 
#include "../stdafx.h"
#include "../strings_func.h"
#include "../date_func.h"
#include "core/game_info.h"
#include "network_admin.h"
#include "network_base.h"
#include "network_server.h"
#include "../command_func.h"
#include "../company_base.h"
#include "../console_func.h"
#include "../core/pool_func.hpp"
#include "../map_func.h"
#include "../rev.h"
#include "../game/game.hpp"
 
#include "../safeguards.h"
 
 
/* This file handles all the admin network commands. */
 
AdminIndex _redirect_console_to_admin = INVALID_ADMIN_ID;
 
byte _network_admins_connected = 0;
 
NetworkAdminSocketPool _networkadminsocket_pool("NetworkAdminSocket");
INSTANTIATE_POOL_METHODS(NetworkAdminSocket)
 
 
static const std::chrono::seconds ADMIN_AUTHORISATION_TIMEOUT(10);
 
 
static const AdminUpdateFrequency _admin_update_type_frequencies[] = {
  ADMIN_FREQUENCY_POLL | ADMIN_FREQUENCY_DAILY | ADMIN_FREQUENCY_WEEKLY | ADMIN_FREQUENCY_MONTHLY | ADMIN_FREQUENCY_QUARTERLY | ADMIN_FREQUENCY_ANUALLY, 
  ADMIN_FREQUENCY_POLL | ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
  ADMIN_FREQUENCY_POLL | ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
  ADMIN_FREQUENCY_POLL |                         ADMIN_FREQUENCY_WEEKLY | ADMIN_FREQUENCY_MONTHLY | ADMIN_FREQUENCY_QUARTERLY | ADMIN_FREQUENCY_ANUALLY, 
  ADMIN_FREQUENCY_POLL |                         ADMIN_FREQUENCY_WEEKLY | ADMIN_FREQUENCY_MONTHLY | ADMIN_FREQUENCY_QUARTERLY | ADMIN_FREQUENCY_ANUALLY, 
                         ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
                         ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
  ADMIN_FREQUENCY_POLL,                                                                                                                                  
                         ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
                         ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
};
static_assert(lengthof(_admin_update_type_frequencies) == ADMIN_UPDATE_END);
 
ServerNetworkAdminSocketHandler::ServerNetworkAdminSocketHandler(SOCKET s) : NetworkAdminSocketHandler(s)
{
  _network_admins_connected++;
  this->status = ADMIN_STATUS_INACTIVE;
  this->connect_time = std::chrono::steady_clock::now();
}
 
ServerNetworkAdminSocketHandler::~ServerNetworkAdminSocketHandler()
{
  _network_admins_connected--;
  Debug(net, 3, "[admin] '{}' ({}) has disconnected", this->admin_name, this->admin_version);
  if (_redirect_console_to_admin == this->index) _redirect_console_to_admin = INVALID_ADMIN_ID;
 
  if (this->update_frequency[ADMIN_UPDATE_CONSOLE] & ADMIN_FREQUENCY_AUTOMATIC) {
    this->update_frequency[ADMIN_UPDATE_CONSOLE] = (AdminUpdateFrequency)0;
    DebugReconsiderSendRemoteMessages();
  }
}
 
/* static */ bool ServerNetworkAdminSocketHandler::AllowConnection()
{
  bool accept = !_settings_client.network.admin_password.empty() && _network_admins_connected < MAX_ADMINS;
  /* We can't go over the MAX_ADMINS limit here. However, if we accept
   * the connection, there has to be space in the pool. */
  static_assert(NetworkAdminSocketPool::MAX_SIZE == MAX_ADMINS);
  assert(!accept || ServerNetworkAdminSocketHandler::CanAllocateItem());
  return accept;
}
 
/* static */ void ServerNetworkAdminSocketHandler::Send()
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::Iterate()) {
    if (as->status == ADMIN_STATUS_INACTIVE && std::chrono::steady_clock::now() > as->connect_time + ADMIN_AUTHORISATION_TIMEOUT) {
      Debug(net, 2, "[admin] Admin did not send its authorisation within {} seconds", std::chrono::duration_cast<std::chrono::seconds>(ADMIN_AUTHORISATION_TIMEOUT).count());
      as->CloseConnection(true);
      continue;
    }
    if (as->writable) {
      as->SendPackets();
    }
  }
}
 
/* static */ void ServerNetworkAdminSocketHandler::AcceptConnection(SOCKET s, const NetworkAddress &address)
{
  ServerNetworkAdminSocketHandler *as = new ServerNetworkAdminSocketHandler(s);
  as->address = address; // Save the IP of the client
}
 
/***********
 * Sending functions for admin network
 ************/
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendError(NetworkErrorCode error)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_ERROR);
 
  p->Send_uint8(error);
  this->SendPacket(p);
 
  std::string error_message = GetString(GetNetworkErrorMsg(error));
 
  Debug(net, 1, "[admin] The admin '{}' ({}) made an error and has been disconnected: '{}'", this->admin_name, this->admin_version, error_message);
 
  return this->CloseConnection(true);
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendProtocol()
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_PROTOCOL);
 
  /* announce the protocol version */
  p->Send_uint8(NETWORK_GAME_ADMIN_VERSION);
 
  for (int i = 0; i < ADMIN_UPDATE_END; i++) {
    p->Send_bool  (true);
    p->Send_uint16(i);
    p->Send_uint16(_admin_update_type_frequencies[i]);
  }
 
  p->Send_bool(false);
  this->SendPacket(p);
 
  return this->SendWelcome();
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendWelcome()
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_WELCOME);
 
  p->Send_string(_settings_client.network.server_name);
  p->Send_string(GetNetworkRevisionString());
  p->Send_bool  (_network_dedicated);
 
  p->Send_string(""); // Used to be map-name.
  p->Send_uint32(_settings_game.game_creation.generation_seed);
  p->Send_uint8 (_settings_game.game_creation.landscape);
  p->Send_uint32(ConvertYMDToDate(_settings_game.game_creation.starting_year, 0, 1));
  p->Send_uint16(MapSizeX());
  p->Send_uint16(MapSizeY());
 
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendNewGame()
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_NEWGAME);
  this->SendPacket(p);
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendShutdown()
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_SHUTDOWN);
  this->SendPacket(p);
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendDate()
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_DATE);
 
  p->Send_uint32(_date);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientJoin(ClientID client_id)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_JOIN);
 
  p->Send_uint32(client_id);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientInfo(const NetworkClientSocket *cs, const NetworkClientInfo *ci)
{
  /* Only send data when we're a proper client, not just someone trying to query the server. */
  if (ci == nullptr) return NETWORK_RECV_STATUS_OKAY;
 
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_INFO);
 
  p->Send_uint32(ci->client_id);
  p->Send_string(cs == nullptr ? "" : const_cast<NetworkAddress &>(cs->client_address).GetHostname());
  p->Send_string(ci->client_name);
  p->Send_uint8 (0); // Used to be language
  p->Send_uint32(ci->join_date);
  p->Send_uint8 (ci->client_playas);
 
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientUpdate(const NetworkClientInfo *ci)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_UPDATE);
 
  p->Send_uint32(ci->client_id);
  p->Send_string(ci->client_name);
  p->Send_uint8 (ci->client_playas);
 
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientQuit(ClientID client_id)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_QUIT);
 
  p->Send_uint32(client_id);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientError(ClientID client_id, NetworkErrorCode error)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_ERROR);
 
  p->Send_uint32(client_id);
  p->Send_uint8 (error);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyNew(CompanyID company_id)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_NEW);
  p->Send_uint8(company_id);
 
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyInfo(const Company *c)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_INFO);
 
  p->Send_uint8 (c->index);
  SetDParam(0, c->index);
  p->Send_string(GetString(STR_COMPANY_NAME));
  SetDParam(0, c->index);
  p->Send_string(GetString(STR_PRESIDENT_NAME));
  p->Send_uint8 (c->colour);
  p->Send_bool  (NetworkCompanyIsPassworded(c->index));
  p->Send_uint32(c->inaugurated_year);
  p->Send_bool  (c->is_ai);
  p->Send_uint8 (CeilDiv(c->months_of_bankruptcy, 3)); // send as quarters_of_bankruptcy
 
  for (size_t i = 0; i < lengthof(c->share_owners); i++) {
    p->Send_uint8(c->share_owners[i]);
  }
 
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyUpdate(const Company *c)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_UPDATE);
 
  p->Send_uint8 (c->index);
  SetDParam(0, c->index);
  p->Send_string(GetString(STR_COMPANY_NAME));
  SetDParam(0, c->index);
  p->Send_string(GetString(STR_PRESIDENT_NAME));
  p->Send_uint8 (c->colour);
  p->Send_bool  (NetworkCompanyIsPassworded(c->index));
  p->Send_uint8 (CeilDiv(c->months_of_bankruptcy, 3)); // send as quarters_of_bankruptcy
 
  for (size_t i = 0; i < lengthof(c->share_owners); i++) {
    p->Send_uint8(c->share_owners[i]);
  }
 
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason acrr)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_REMOVE);
 
  p->Send_uint8(company_id);
  p->Send_uint8(acrr);
 
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyEconomy()
{
  for (const Company *company : Company::Iterate()) {
    /* Get the income. */
    Money income = 0;
    for (uint i = 0; i < lengthof(company->yearly_expenses[0]); i++) {
      income -= company->yearly_expenses[0][i];
    }
 
    Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_ECONOMY);
 
    p->Send_uint8(company->index);
 
    /* Current information. */
    p->Send_uint64(company->money);
    p->Send_uint64(company->current_loan);
    p->Send_uint64(income);
    p->Send_uint16(static_cast<uint16>(std::min<uint64>(UINT16_MAX, company->cur_economy.delivered_cargo.GetSum<OverflowSafeInt64>())));
 
    /* Send stats for the last 2 quarters. */
    for (uint i = 0; i < 2; i++) {
      p->Send_uint64(company->old_economy[i].company_value);
      p->Send_uint16(company->old_economy[i].performance_history);
      p->Send_uint16(static_cast<uint16>(std::min<uint64>(UINT16_MAX, company->old_economy[i].delivered_cargo.GetSum<OverflowSafeInt64>())));
    }
 
    this->SendPacket(p);
  }
 
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyStats()
{
  /* Fetch the latest version of the stats. */
  NetworkCompanyStats company_stats[MAX_COMPANIES];
  NetworkPopulateCompanyStats(company_stats);
 
  /* Go through all the companies. */
  for (const Company *company : Company::Iterate()) {
    Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_STATS);
 
    /* Send the information. */
    p->Send_uint8(company->index);
 
    for (uint i = 0; i < NETWORK_VEH_END; i++) {
      p->Send_uint16(company_stats[company->index].num_vehicle[i]);
    }
 
    for (uint i = 0; i < NETWORK_VEH_END; i++) {
      p->Send_uint16(company_stats[company->index].num_station[i]);
    }
 
    this->SendPacket(p);
  }
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendChat(NetworkAction action, DestType desttype, ClientID client_id, const std::string &msg, int64 data)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CHAT);
 
  p->Send_uint8 (action);
  p->Send_uint8 (desttype);
  p->Send_uint32(client_id);
  p->Send_string(msg);
  p->Send_uint64(data);
 
  this->SendPacket(p);
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendRconEnd(const std::string_view command)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_RCON_END);
 
  p->Send_string(command);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendRcon(uint16 colour, const std::string_view result)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_RCON);
 
  p->Send_uint16(colour);
  p->Send_string(result);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_RCON(Packet *p)
{
  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
 
  std::string command = p->Recv_string(NETWORK_RCONCOMMAND_LENGTH);
 
  Debug(net, 3, "[admin] Rcon command from '{}' ({}): {}", this->admin_name, this->admin_version, command);
 
  _redirect_console_to_admin = this->index;
  IConsoleCmdExec(command.c_str());
  _redirect_console_to_admin = INVALID_ADMIN_ID;
  return this->SendRconEnd(command);
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_GAMESCRIPT(Packet *p)
{
  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
 
  std::string json = p->Recv_string(NETWORK_GAMESCRIPT_JSON_LENGTH);
 
  Debug(net, 6, "[admin] GameScript JSON from '{}' ({}): {}", this->admin_name, this->admin_version, json);
 
  Game::NewEvent(new ScriptEventAdminPort(json));
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_PING(Packet *p)
{
  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
 
  uint32 d1 = p->Recv_uint32();
 
  Debug(net, 6, "[admin] Ping from '{}' ({}): {}", this->admin_name, this->admin_version, d1);
 
  return this->SendPong(d1);
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendConsole(const std::string_view origin, const std::string_view string)
{
  /* If the length of both strings, plus the 2 '\0' terminations and 3 bytes of the packet
   * are bigger than the MTU, just ignore the message. Better safe than sorry. It should
   * never occur though as the longest strings are chat messages, which are still 30%
   * smaller than COMPAT_MTU. */
  if (origin.size() + string.size() + 2 + 3 >= COMPAT_MTU) return NETWORK_RECV_STATUS_OKAY;
 
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CONSOLE);
 
  p->Send_string(origin);
  p->Send_string(string);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendGameScript(const std::string_view json)
{
  /* At the moment we cannot transmit anything larger than MTU. So we limit
   *  the maximum amount of json data that can be sent. Account also for
   *  the trailing \0 of the string */
  if (json.size() + 1 >= NETWORK_GAMESCRIPT_JSON_LENGTH) return NETWORK_RECV_STATUS_OKAY;
 
  Packet *p = new Packet(ADMIN_PACKET_SERVER_GAMESCRIPT);
 
  p->Send_string(json);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendPong(uint32 d1)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_PONG);
 
  p->Send_uint32(d1);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCmdNames()
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CMD_NAMES);
 
  for (uint i = 0; i < CMD_END; i++) {
    const char *cmdname = GetCommandName(i);
 
    /* Should COMPAT_MTU be exceeded, start a new packet
     * (magic 5: 1 bool "more data" and one uint16 "command id", one
     * byte for string '\0' termination and 1 bool "no more data" */
    if (!p->CanWriteToPacket(strlen(cmdname) + 5)) {
      p->Send_bool(false);
      this->SendPacket(p);
 
      p = new Packet(ADMIN_PACKET_SERVER_CMD_NAMES);
    }
 
    p->Send_bool(true);
    p->Send_uint16(i);
    p->Send_string(cmdname);
  }
 
  /* Marker to notify the end of the packet has been reached. */
  p->Send_bool(false);
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCmdLogging(ClientID client_id, const CommandPacket *cp)
{
  Packet *p = new Packet(ADMIN_PACKET_SERVER_CMD_LOGGING);
 
  p->Send_uint32(client_id);
  p->Send_uint8 (cp->company);
  p->Send_uint16(cp->cmd & CMD_ID_MASK);
  p->Send_uint32(cp->p1);
  p->Send_uint32(cp->p2);
  p->Send_uint32(cp->tile);
  p->Send_string(cp->text);
  p->Send_uint32(cp->frame);
 
  this->SendPacket(p);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
/***********
 * Receiving functions
 ************/
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_JOIN(Packet *p)
{
  if (this->status != ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
 
  std::string password = p->Recv_string(NETWORK_PASSWORD_LENGTH);
 
  if (_settings_client.network.admin_password.empty() ||
      _settings_client.network.admin_password.compare(password) != 0) {
    /* Password is invalid */
    return this->SendError(NETWORK_ERROR_WRONG_PASSWORD);
  }
 
  this->admin_name = p->Recv_string(NETWORK_CLIENT_NAME_LENGTH);
  this->admin_version = p->Recv_string(NETWORK_REVISION_LENGTH);
 
  if (this->admin_name.empty() || this->admin_version.empty()) {
    /* no name or version supplied */
    return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
  }
 
  this->status = ADMIN_STATUS_ACTIVE;
 
  Debug(net, 3, "[admin] '{}' ({}) has connected", this->admin_name, this->admin_version);
 
  return this->SendProtocol();
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_QUIT(Packet *p)
{
  /* The admin is leaving nothing else to do */
  return this->CloseConnection();
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_UPDATE_FREQUENCY(Packet *p)
{
  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
 
  AdminUpdateType type = (AdminUpdateType)p->Recv_uint16();
  AdminUpdateFrequency freq = (AdminUpdateFrequency)p->Recv_uint16();
 
  if (type >= ADMIN_UPDATE_END || (_admin_update_type_frequencies[type] & freq) != freq) {
    /* The server does not know of this UpdateType. */
    Debug(net, 1, "[admin] Not supported update frequency {} ({}) from '{}' ({})", type, freq, this->admin_name, this->admin_version);
    return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
  }
 
  this->update_frequency[type] = freq;
 
  if (type == ADMIN_UPDATE_CONSOLE) DebugReconsiderSendRemoteMessages();
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_POLL(Packet *p)
{
  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
 
  AdminUpdateType type = (AdminUpdateType)p->Recv_uint8();
  uint32 d1 = p->Recv_uint32();
 
  switch (type) {
    case ADMIN_UPDATE_DATE:
      /* The admin is requesting the current date. */
      this->SendDate();
      break;
 
    case ADMIN_UPDATE_CLIENT_INFO:
      /* The admin is requesting client info. */
      if (d1 == UINT32_MAX) {
        this->SendClientInfo(nullptr, NetworkClientInfo::GetByClientID(CLIENT_ID_SERVER));
        for (const NetworkClientSocket *cs : NetworkClientSocket::Iterate()) {
          this->SendClientInfo(cs, cs->GetInfo());
        }
      } else {
        if (d1 == CLIENT_ID_SERVER) {
          this->SendClientInfo(nullptr, NetworkClientInfo::GetByClientID(CLIENT_ID_SERVER));
        } else {
          const NetworkClientSocket *cs = NetworkClientSocket::GetByClientID((ClientID)d1);
          if (cs != nullptr) this->SendClientInfo(cs, cs->GetInfo());
        }
      }
      break;
 
    case ADMIN_UPDATE_COMPANY_INFO:
      /* The admin is asking for company info. */
      if (d1 == UINT32_MAX) {
        for (const Company *company : Company::Iterate()) {
          this->SendCompanyInfo(company);
        }
      } else {
        const Company *company = Company::GetIfValid(d1);
        if (company != nullptr) this->SendCompanyInfo(company);
      }
      break;
 
    case ADMIN_UPDATE_COMPANY_ECONOMY:
      /* The admin is requesting economy info. */
      this->SendCompanyEconomy();
      break;
 
    case ADMIN_UPDATE_COMPANY_STATS:
      /* the admin is requesting company stats. */
      this->SendCompanyStats();
      break;
 
    case ADMIN_UPDATE_CMD_NAMES:
      /* The admin is requesting the names of DoCommands. */
      this->SendCmdNames();
      break;
 
    default:
      /* An unsupported "poll" update type. */
      Debug(net, 1, "[admin] Not supported poll {} ({}) from '{}' ({}).", type, d1, this->admin_name, this->admin_version);
      return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
  }
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_CHAT(Packet *p)
{
  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
 
  NetworkAction action = (NetworkAction)p->Recv_uint8();
  DestType desttype = (DestType)p->Recv_uint8();
  int dest = p->Recv_uint32();
 
  std::string msg = p->Recv_string(NETWORK_CHAT_LENGTH);
 
  switch (action) {
    case NETWORK_ACTION_CHAT:
    case NETWORK_ACTION_CHAT_CLIENT:
    case NETWORK_ACTION_CHAT_COMPANY:
    case NETWORK_ACTION_SERVER_MESSAGE:
      NetworkServerSendChat(action, desttype, dest, msg, _network_own_client_id, 0, true);
      break;
 
    default:
      Debug(net, 1, "[admin] Invalid chat action {} from admin '{}' ({}).", action, this->admin_name, this->admin_version);
      return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
  }
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_EXTERNAL_CHAT(Packet *p)
{
  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
 
  std::string source = p->Recv_string(NETWORK_CHAT_LENGTH);
  TextColour colour = (TextColour)p->Recv_uint16();
  std::string user = p->Recv_string(NETWORK_CHAT_LENGTH);
  std::string msg = p->Recv_string(NETWORK_CHAT_LENGTH);
 
  if (!IsValidConsoleColour(colour)) {
    Debug(net, 1, "[admin] Not supported chat colour {} ({}, {}, {}) from '{}' ({}).", (uint16)colour, source, user, msg, this->admin_name, this->admin_version);
    return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
  }
 
  NetworkServerSendExternalChat(source, colour, user, msg);
 
  return NETWORK_RECV_STATUS_OKAY;
}
 
/*
 * Useful wrapper functions
 */
 
void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client)
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
      as->SendClientInfo(cs, cs->GetInfo());
      if (new_client) {
        as->SendClientJoin(cs->client_id);
      }
    }
  }
}
 
void NetworkAdminClientUpdate(const NetworkClientInfo *ci)
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
      as->SendClientUpdate(ci);
    }
  }
}
 
void NetworkAdminClientQuit(ClientID client_id)
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
      as->SendClientQuit(client_id);
    }
  }
}
 
void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code)
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
      as->SendClientError(client_id, error_code);
    }
  }
}
 
void NetworkAdminCompanyInfo(const Company *company, bool new_company)
{
  if (company == nullptr) {
    Debug(net, 1, "[admin] Empty company given for update");
    return;
  }
 
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_COMPANY_INFO] != ADMIN_FREQUENCY_AUTOMATIC) continue;
 
    as->SendCompanyInfo(company);
    if (new_company) {
      as->SendCompanyNew(company->index);
    }
  }
}
 
void NetworkAdminCompanyUpdate(const Company *company)
{
  if (company == nullptr) return;
 
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_COMPANY_INFO] != ADMIN_FREQUENCY_AUTOMATIC) continue;
 
    as->SendCompanyUpdate(company);
  }
}
 
void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    as->SendCompanyRemove(company_id, bcrr);
  }
}
 
 
void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const std::string &msg, int64 data, bool from_admin)
{
  if (from_admin) return;
 
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_CHAT] & ADMIN_FREQUENCY_AUTOMATIC) {
      as->SendChat(action, desttype, client_id, msg, data);
    }
  }
}
 
void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const std::string_view string)
{
  ServerNetworkAdminSocketHandler::Get(admin_index)->SendRcon(colour_code, string);
}
 
void NetworkAdminConsole(const std::string_view origin, const std::string_view string)
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_CONSOLE] & ADMIN_FREQUENCY_AUTOMATIC) {
      as->SendConsole(origin, string);
    }
  }
}
 
void NetworkAdminGameScript(const std::string_view json)
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_GAMESCRIPT] & ADMIN_FREQUENCY_AUTOMATIC) {
      as->SendGameScript(json);
    }
  }
}
 
void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp)
{
  ClientID client_id = owner == nullptr ? _network_own_client_id : owner->client_id;
 
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    if (as->update_frequency[ADMIN_UPDATE_CMD_LOGGING] & ADMIN_FREQUENCY_AUTOMATIC) {
      as->SendCmdLogging(client_id, cp);
    }
  }
}
 
void ServerNetworkAdminSocketHandler::WelcomeAll()
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    as->SendWelcome();
  }
}
 
void NetworkAdminUpdate(AdminUpdateFrequency freq)
{
  for (ServerNetworkAdminSocketHandler *as : ServerNetworkAdminSocketHandler::IterateActive()) {
    for (int i = 0; i < ADMIN_UPDATE_END; i++) {
      if (as->update_frequency[i] & freq) {
        /* Update the admin for the required details */
        switch (i) {
          case ADMIN_UPDATE_DATE:
            as->SendDate();
            break;
 
          case ADMIN_UPDATE_COMPANY_ECONOMY:
            as->SendCompanyEconomy();
            break;
 
          case ADMIN_UPDATE_COMPANY_STATS:
            as->SendCompanyStats();
            break;
 
          default: NOT_REACHED();
        }
      }
    }
  }
}