Maintain a circular buffer of recent commands, add to crashlog.

[openttd-joker.git] / src / network / network_admin.cpp

/* $Id: network_admin.cpp 25845 2013-10-12 17:03:15Z planetmaker $ */

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

/** @file network_admin.cpp Server part of the admin network protocol. */

#ifdef ENABLE_NETWORK

#include "../stdafx.h"
#include "../strings_func.h"
#include "../date_func.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. */

/** Redirection of the (remote) console to the admin. */
AdminIndex _redirect_console_to_admin = INVALID_ADMIN_ID;

/** The amount of admins connected. */
byte _network_admins_connected = 0;

/** The pool with sockets/clients. */
NetworkAdminSocketPool _networkadminsocket_pool("NetworkAdminSocket");
INSTANTIATE_POOL_METHODS(NetworkAdminSocket)

/** The timeout for authorisation of the client. */
static const int ADMIN_AUTHORISATION_TIMEOUT = 10000;


/** Frequencies, which may be registered for a certain update type. */
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_UPDATE_DATE
        ADMIN_FREQUENCY_POLL | ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      ///< ADMIN_UPDATE_CLIENT_INFO
        ADMIN_FREQUENCY_POLL | ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      ///< ADMIN_UPDATE_COMPANY_INFO
        ADMIN_FREQUENCY_POLL |                         ADMIN_FREQUENCY_WEEKLY | ADMIN_FREQUENCY_MONTHLY | ADMIN_FREQUENCY_QUARTERLY | ADMIN_FREQUENCY_ANUALLY, ///< ADMIN_UPDATE_COMPANY_ECONOMY
        ADMIN_FREQUENCY_POLL |                         ADMIN_FREQUENCY_WEEKLY | ADMIN_FREQUENCY_MONTHLY | ADMIN_FREQUENCY_QUARTERLY | ADMIN_FREQUENCY_ANUALLY, ///< ADMIN_UPDATE_COMPANY_STATS
                               ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      ///< ADMIN_UPDATE_CHAT
                               ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      ///< ADMIN_UPDATE_CONSOLE
        ADMIN_FREQUENCY_POLL,                                                                                                                                  ///< ADMIN_UPDATE_CMD_NAMES
                               ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      ///< ADMIN_UPDATE_CMD_LOGGING
                               ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      ///< ADMIN_UPDATE_GAMESCRIPT
};
/** Sanity check. */
assert_compile(lengthof(_admin_update_type_frequencies) == ADMIN_UPDATE_END);

/**
 * Create a new socket for the server side of the admin network.
 * @param s The socket to connect with.
 */
ServerNetworkAdminSocketHandler::ServerNetworkAdminSocketHandler(SOCKET s) : NetworkAdminSocketHandler(s)
{
        _network_admins_connected++;
        this->status = ADMIN_STATUS_INACTIVE;
        this->realtime_connect = _realtime_tick;
}

/**
 * Clear everything related to this admin.
 */
ServerNetworkAdminSocketHandler::~ServerNetworkAdminSocketHandler()
{
        _network_admins_connected--;
        DEBUG(net, 1, "[admin] '%s' (%s) has disconnected", this->admin_name, this->admin_version);
        if (_redirect_console_to_admin == this->index) _redirect_console_to_admin = INVALID_ADMIN_ID;
}

/**
 * Whether a connection is allowed or not at this moment.
 * @return Whether the connection is allowed.
 */
/* static */ bool ServerNetworkAdminSocketHandler::AllowConnection()
{
        bool accept = !StrEmpty(_settings_client.network.admin_password) && _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. */
        assert_compile(NetworkAdminSocketPool::MAX_SIZE == MAX_ADMINS);
        assert(!accept || ServerNetworkAdminSocketHandler::CanAllocateItem());
        return accept;
}

/** Send the packets for the server sockets. */
/* static */ void ServerNetworkAdminSocketHandler::Send()
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ADMIN_SOCKETS(as) {
                if (as->status == ADMIN_STATUS_INACTIVE && as->realtime_connect + ADMIN_AUTHORISATION_TIMEOUT < _realtime_tick) {
                        DEBUG(net, 1, "[admin] Admin did not send its authorisation within %d seconds", ADMIN_AUTHORISATION_TIMEOUT / 1000);
                        as->CloseConnection(true);
                        continue;
                }
                if (as->writable) {
                        as->SendPackets();
                }
        }
}

/**
 * Handle the acception of a connection.
 * @param s The socket of the new connection.
 * @param address The address of the peer.
 */
/* 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
 ************/

/**
 * Send an error to the admin.
 * @param error The error to send.
 */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendError(NetworkErrorCode error)
{
        Packet *p = new Packet(ADMIN_PACKET_SERVER_ERROR);

        p->Send_uint8(error);
        this->SendPacket(p);

        char str[100];
        StringID strid = GetNetworkErrorMsg(error);
        GetString(str, strid, lastof(str));

        DEBUG(net, 1, "[admin] the admin '%s' (%s) made an error and has been disconnected. Reason: '%s'", this->admin_name, this->admin_version, str);

        return this->CloseConnection(true);
}

/** Send the protocol version to the admin. */
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();
}

/** Send a welcome message to the admin. */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendWelcome()
{
        Packet *p = new Packet(ADMIN_PACKET_SERVER_WELCOME);

        p->Send_string(_settings_client.network.server_name);
        p->Send_string(_openttd_revision);
        p->Send_bool  (_network_dedicated);

        p->Send_string(_network_game_info.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;
}

/** Tell the admin we started a new game. */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendNewGame()
{
        Packet *p = new Packet(ADMIN_PACKET_SERVER_NEWGAME);
        this->SendPacket(p);
        return NETWORK_RECV_STATUS_OKAY;
}

/** Tell the admin we're shutting down. */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendShutdown()
{
        Packet *p = new Packet(ADMIN_PACKET_SERVER_SHUTDOWN);
        this->SendPacket(p);
        return NETWORK_RECV_STATUS_OKAY;
}

/** Tell the admin the date. */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendDate()
{
        Packet *p = new Packet(ADMIN_PACKET_SERVER_DATE);

        p->Send_uint32(_date);
        this->SendPacket(p);

        return NETWORK_RECV_STATUS_OKAY;
}

/**
 * Tell the admin that a client joined.
 * @param client_id The client that joined.
 */
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;
}

/**
 * Send an initial set of data from some client's information.
 * @param cs The socket of the client.
 * @param ci The information about the client.
 */
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 == NULL) return NETWORK_RECV_STATUS_OKAY;

        Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_INFO);

        p->Send_uint32(ci->client_id);
        p->Send_string(cs == NULL ? "" : const_cast<NetworkAddress &>(cs->client_address).GetHostname());
        p->Send_string(ci->client_name);
        p->Send_uint8 (ci->client_lang);
        p->Send_uint32(ci->join_date);
        p->Send_uint8 (ci->client_playas);

        this->SendPacket(p);

        return NETWORK_RECV_STATUS_OKAY;
}


/**
 * Send an update for some client's information.
 * @param ci The information about a client.
 */
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;
}

/**
 * Tell the admin that a client quit.
 * @param client_id The client that quit.
 */
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;
}

/**
 * Tell the admin that a client made an error.
 * @param client_id The client that made the error.
 * @param error The error that was made.
 */
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;
}

/**
 * Tell the admin that a new company was founded.
 * @param company_id The company that was founded.
 */
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;
}

/**
 * Send the admin some information about a company.
 * @param c The company to send the information about.
 */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyInfo(const Company *c)
{
        char company_name[NETWORK_COMPANY_NAME_LENGTH];
        char manager_name[NETWORK_COMPANY_NAME_LENGTH];

        SetDParam(0, c->index);
        GetString(company_name, STR_COMPANY_NAME, lastof(company_name));

        SetDParam(0, c->index);
        GetString(manager_name, STR_PRESIDENT_NAME, lastof(manager_name));

        Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_INFO);

        p->Send_uint8 (c->index);
        p->Send_string(company_name);
        p->Send_string(manager_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;
}


/**
 * Send an update about a company.
 * @param c The company to send the update of.
 */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyUpdate(const Company *c)
{
        char company_name[NETWORK_COMPANY_NAME_LENGTH];
        char manager_name[NETWORK_COMPANY_NAME_LENGTH];

        SetDParam(0, c->index);
        GetString(company_name, STR_COMPANY_NAME, lastof(company_name));

        SetDParam(0, c->index);
        GetString(manager_name, STR_PRESIDENT_NAME, lastof(manager_name));

        Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_UPDATE);

        p->Send_uint8 (c->index);
        p->Send_string(company_name);
        p->Send_string(manager_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;
}

/**
 * Tell the admin that a company got removed.
 * @param company_id The company that got removed.
 * @param acrr The reason for removal, e.g. bankruptcy or merger.
 */
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;
}

/** Send economic information of all companies. */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyEconomy()
{
        const Company *company;
        FOR_ALL_COMPANIES(company) {
                /* 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(min(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(min(UINT16_MAX, company->old_economy[i].delivered_cargo.GetSum<OverflowSafeInt64>()));
                }

                this->SendPacket(p);
        }


        return NETWORK_RECV_STATUS_OKAY;
}

/** Send statistics about the companies. */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyStats()
{
        /* Fetch the latest version of the stats. */
        NetworkCompanyStats company_stats[MAX_COMPANIES];
        NetworkPopulateCompanyStats(company_stats);

        const Company *company;

        /* Go through all the companies. */
        FOR_ALL_COMPANIES(company) {
                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;
}

/**
 * Send a chat message.
 * @param action The action associated with the message.
 * @param desttype The destination type.
 * @param client_id The origin of the chat message.
 * @param msg The actual message.
 * @param data Arbitrary extra data.
 */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendChat(NetworkAction action, DestType desttype, ClientID client_id, const char *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;
}

/**
 * Send a notification indicating the rcon command has completed.
 * @param command The original command sent.
 */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendRconEnd(const char *command)
{
        Packet *p = new Packet(ADMIN_PACKET_SERVER_RCON_END);

        p->Send_string(command);
        this->SendPacket(p);

        return NETWORK_RECV_STATUS_OKAY;
}

/**
 * Send the reply of an rcon command.
 * @param colour The colour of the text.
 * @param result The result of the command.
 */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendRcon(uint16 colour, const char *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);

        char command[NETWORK_RCONCOMMAND_LENGTH];

        p->Recv_string(command, sizeof(command));

        DEBUG(net, 2, "[admin] Rcon command from '%s' (%s): '%s'", this->admin_name, this->admin_version, command);

        _redirect_console_to_admin = this->index;
        IConsoleCmdExec(command);
        _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);

        char json[NETWORK_GAMESCRIPT_JSON_LENGTH];

        p->Recv_string(json, sizeof(json));

        DEBUG(net, 2, "[admin] GameScript JSON from '%s' (%s): '%s'", 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, 2, "[admin] Ping from '%s' (%s): '%d'", this->admin_name, this->admin_version, d1);

        return this->SendPong(d1);
}

/**
 * Send console output of other clients.
 * @param origin The origin of the string.
 * @param string The string that's put on the console.
 */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendConsole(const char *origin, const char *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 SEND_MTU. */
        if (strlen(origin) + strlen(string) + 2 + 3 >= SEND_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;
}

/**
 * Send GameScript JSON output.
 * @param json The JSON string.
 */
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendGameScript(const char *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 (strlen(json) + 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;
}

/** Send ping-reply (pong) to admin **/
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;
}

/** Send the names of the commands. */
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 SEND_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->size + strlen(cmdname) + 5 >= SEND_MTU) {
                        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;
}

/**
 * Send a command for logging purposes.
 * @param client_id The client executing the command.
 * @param cp The command that would be executed.
 */
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);

        char password[NETWORK_PASSWORD_LENGTH];
        p->Recv_string(password, sizeof(password));

        if (StrEmpty(_settings_client.network.admin_password) ||
                        strcmp(password, _settings_client.network.admin_password) != 0) {
                /* Password is invalid */
                return this->SendError(NETWORK_ERROR_WRONG_PASSWORD);
        }

        p->Recv_string(this->admin_name, sizeof(this->admin_name));
        p->Recv_string(this->admin_version, sizeof(this->admin_version));

        if (StrEmpty(this->admin_name) || StrEmpty(this->admin_version)) {
                /* no name or version supplied */
                return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
        }

        this->status = ADMIN_STATUS_ACTIVE;

        DEBUG(net, 1, "[admin] '%s' (%s) 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, 3, "[admin] Not supported update frequency %d (%d) from '%s' (%s).", type, freq, this->admin_name, this->admin_version);
                return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
        }

        this->update_frequency[type] = freq;

        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. */
                        const NetworkClientSocket *cs;
                        if (d1 == UINT32_MAX) {
                                this->SendClientInfo(NULL, NetworkClientInfo::GetByClientID(CLIENT_ID_SERVER));
                                FOR_ALL_CLIENT_SOCKETS(cs) {
                                        this->SendClientInfo(cs, cs->GetInfo());
                                }
                        } else {
                                if (d1 == CLIENT_ID_SERVER) {
                                        this->SendClientInfo(NULL, NetworkClientInfo::GetByClientID(CLIENT_ID_SERVER));
                                } else {
                                        cs = NetworkClientSocket::GetByClientID((ClientID)d1);
                                        if (cs != NULL) this->SendClientInfo(cs, cs->GetInfo());
                                }
                        }
                        break;

                case ADMIN_UPDATE_COMPANY_INFO:
                        /* The admin is asking for company info. */
                        const Company *company;
                        if (d1 == UINT32_MAX) {
                                FOR_ALL_COMPANIES(company) {
                                        this->SendCompanyInfo(company);
                                }
                        } else {
                                company = Company::GetIfValid(d1);
                                if (company != NULL) 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, 3, "[admin] Not supported poll %d (%d) from '%s' (%s).", 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();

        char msg[NETWORK_CHAT_LENGTH];
        p->Recv_string(msg, 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, 3, "[admin] Invalid chat action %d from admin '%s' (%s).", action, this->admin_name, this->admin_version);
                        return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
        }

        return NETWORK_RECV_STATUS_OKAY;
}

/*
 * Useful wrapper functions
 */

/**
 * Notify the admin network of a new client (if they did opt in for the respective update).
 * @param cs the client info.
 * @param new_client if this is a new client, send the respective packet too.
 */
void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client)
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
                        as->SendClientInfo(cs, cs->GetInfo());
                        if (new_client) {
                                as->SendClientJoin(cs->client_id);
                        }
                }
        }
}

/**
 * Notify the admin network of a client update (if they did opt in for the respective update).
 * @param ci the client info.
 */
void NetworkAdminClientUpdate(const NetworkClientInfo *ci)
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
                        as->SendClientUpdate(ci);
                }
        }
}

/**
 * Notify the admin network that a client quit (if they have opt in for the respective update).
 * @param client_id of the client that quit.
 */
void NetworkAdminClientQuit(ClientID client_id)
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
                        as->SendClientQuit(client_id);
                }
        }
}

/**
 * Notify the admin network of a client error (if they have opt in for the respective update).
 * @param client_id the client that made the error.
 * @param error_code the error that was caused.
 */
void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code)
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
                        as->SendClientError(client_id, error_code);
                }
        }
}

/**
 * Notify the admin network of company details.
 * @param company the company of which details will be sent into the admin network.
 * @param new_company whether this is a new company or not.
 */
void NetworkAdminCompanyInfo(const Company *company, bool new_company)
{
        if (company == NULL) {
                DEBUG(net, 1, "[admin] Empty company given for update");
                return;
        }

        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_COMPANY_INFO] != ADMIN_FREQUENCY_AUTOMATIC) continue;

                as->SendCompanyInfo(company);
                if (new_company) {
                        as->SendCompanyNew(company->index);
                }
        }
}

/**
 * Notify the admin network of company updates.
 * @param company company of which updates are going to be sent into the admin network.
 */
void NetworkAdminCompanyUpdate(const Company *company)
{
        if (company == NULL) return;

        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_COMPANY_INFO] != ADMIN_FREQUENCY_AUTOMATIC) continue;

                as->SendCompanyUpdate(company);
        }
}

/**
 * Notify the admin network of a company to be removed (including the reason why).
 * @param company_id ID of the company that got removed.
 * @param bcrr the reason why the company got removed (e.g. bankruptcy).
 */
void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                as->SendCompanyRemove(company_id, bcrr);
        }
}


/**
 * Send chat to the admin network (if they did opt in for the respective update).
 */
void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data, bool from_admin)
{
        if (from_admin) return;

        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_CHAT] & ADMIN_FREQUENCY_AUTOMATIC) {
                        as->SendChat(action, desttype, client_id, msg, data);
                }
        }
}

/**
 * Pass the rcon reply to the admin.
 * @param admin_index The admin to give the reply.
 * @param colour_code The colour of the string.
 * @param string      The string to show.
 */
void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const char *string)
{
        ServerNetworkAdminSocketHandler::Get(admin_index)->SendRcon(colour_code, string);
}

/**
 * Send console to the admin network (if they did opt in for the respective update).
 * @param origin the origin of the message.
 * @param string the message as printed on the console.
 */
void NetworkAdminConsole(const char *origin, const char *string)
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_CONSOLE] & ADMIN_FREQUENCY_AUTOMATIC) {
                        as->SendConsole(origin, string);
                }
        }
}

/**
 * Send GameScript JSON to the admin network (if they did opt in for the respective update).
 * @param json The JSON data as received from the GameScript.
 */
void NetworkAdminGameScript(const char *json)
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_GAMESCRIPT] & ADMIN_FREQUENCY_AUTOMATIC) {
                        as->SendGameScript(json);
                }
        }
}

/**
 * Distribute CommandPacket details over the admin network for logging purposes.
 * @param owner The owner of the CommandPacket (who sent us the CommandPacket).
 * @param cp    The CommandPacket to be distributed.
 */
void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp)
{
        ClientID client_id = owner == NULL ? _network_own_client_id : owner->client_id;

        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                if (as->update_frequency[ADMIN_UPDATE_CMD_LOGGING] & ADMIN_FREQUENCY_AUTOMATIC) {
                        as->SendCmdLogging(client_id, cp);
                }
        }
}

/**
 * Send a Welcome packet to all connected admins
 */
void ServerNetworkAdminSocketHandler::WelcomeAll()
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                as->SendWelcome();
        }
}

/**
 * Send (push) updates to the admin network as they have registered for these updates.
 * @param freq the frequency to be processed.
 */
void NetworkAdminUpdate(AdminUpdateFrequency freq)
{
        ServerNetworkAdminSocketHandler *as;
        FOR_ALL_ACTIVE_ADMIN_SOCKETS(as) {
                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();
                                }
                        }
                }
        }
}

#endif /* ENABLE_NETWORK */