tcp_admin.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef NETWORK_CORE_TCP_ADMIN_H
#define NETWORK_CORE_TCP_ADMIN_H
 
#include "os_abstraction.h"
#include "tcp.h"
#include "../network_type.h"

enum class PacketAdminType : uint8_t {
  AdminJoin, 
  AdminQuit, 
  AdminUpdateFrequency, 
  AdminPoll, 
  AdminChat, 
  AdminRemoteConsoleCommand, 
  AdminGameScript, 
  AdminPing, 
  AdminExternalChat, 
  AdminJoinSecure, 
  AdminAuthenticationResponse, 
 
  ServerFull = 100, 
  ServerBanned, 
  ServerError, 
  ServerProtocol, 
  ServerWelcome, 
  ServerNewGame, 
  ServerShutdown, 
 
  ServerDate, 
  ServerClientJoin, 
  ServerClientInfo, 
  ServerClientUpdate, 
  ServerClientQuit, 
  ServerClientError, 
  ServerCompanyNew, 
  ServerCompanyInfo, 
  ServerCompanyUpdate, 
  ServerCompanyRemove, 
  ServerCompanyEconomy, 
  ServerCompanyStatistics, 
  ServerChat, 
  ServerRemoteConsoleCommand, 
  ServerConsole, 
  ServerCommandNames, 
  ServerCommandLoggingOld, 
  ServerGameScript, 
  ServerRemoteConsoleCommandEnd, 
  ServerPong, 
  ServerCommandLogging, 
  ServerAuthenticationRequest, 
  ServerEnableEncryption, 
};

template <> struct IsEnumPacketType<PacketAdminType> {
  static constexpr bool value = true; 
};

enum AdminStatus : uint8_t {
  ADMIN_STATUS_INACTIVE,      
  ADMIN_STATUS_AUTHENTICATE,  
  ADMIN_STATUS_ACTIVE,        
  ADMIN_STATUS_END,           
};

enum AdminUpdateType : uint8_t {
  ADMIN_UPDATE_DATE,            
  ADMIN_UPDATE_CLIENT_INFO,     
  ADMIN_UPDATE_COMPANY_INFO,    
  ADMIN_UPDATE_COMPANY_ECONOMY, 
  ADMIN_UPDATE_COMPANY_STATS,   
  ADMIN_UPDATE_CHAT,            
  ADMIN_UPDATE_CONSOLE,         
  ADMIN_UPDATE_CMD_NAMES,       
  ADMIN_UPDATE_CMD_LOGGING,     
  ADMIN_UPDATE_GAMESCRIPT,      
  ADMIN_UPDATE_END,             
};

enum class AdminUpdateFrequency : uint8_t {
  Poll, 
  Daily, 
  Weekly, 
  Monthly, 
  Quarterly, 
  Annually, 
  Automatic, 
};
using AdminUpdateFrequencies = EnumBitSet<AdminUpdateFrequency, uint8_t>; 

enum AdminCompanyRemoveReason : uint8_t {
  ADMIN_CRR_MANUAL,    
  ADMIN_CRR_AUTOCLEAN, 
  ADMIN_CRR_BANKRUPT,  
 
  ADMIN_CRR_END,       
};

class NetworkAdminSocketHandler : public NetworkTCPSocketHandler {
protected:
  std::string admin_name{}; 
  std::string admin_version{}; 
  AdminStatus status = ADMIN_STATUS_INACTIVE; 
 
  NetworkRecvStatus ReceiveInvalidPacket(PacketAdminType type);

  virtual NetworkRecvStatus ReceiveAdminJoin(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminQuit(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminUpdateFrequency(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminPoll(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminChat(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminExternalChat(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminRemoteConsoleCommand(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminGameScript(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminPing(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminJoinSecure(Packet &p);

  virtual NetworkRecvStatus ReceiveAdminAuthenticationResponse(Packet &p);

  virtual NetworkRecvStatus ReceiveServerFull(Packet &p);

  virtual NetworkRecvStatus ReceiveServerBanned(Packet &p);

  virtual NetworkRecvStatus ReceiveServerError(Packet &p);

  virtual NetworkRecvStatus ReceiveServerProtocol(Packet &p);

  virtual NetworkRecvStatus ReceiveServerWelcome(Packet &p);

  virtual NetworkRecvStatus ReceiveServerNewGame(Packet &p);

  virtual NetworkRecvStatus ReceiveServerShutdown(Packet &p);

  virtual NetworkRecvStatus ReceiveServerDate(Packet &p);

  virtual NetworkRecvStatus ReceiveServerClientJoin(Packet &p);

  virtual NetworkRecvStatus ReceiveServerClientInfo(Packet &p);

  virtual NetworkRecvStatus ReceiveServerClientUpdate(Packet &p);

  virtual NetworkRecvStatus ReceiveServerClientQuit(Packet &p);

  virtual NetworkRecvStatus ReceiveServerClientError(Packet &p);

  virtual NetworkRecvStatus ReceiveServerCompanyNew(Packet &p);

  virtual NetworkRecvStatus ReceiveServerCompanyInfo(Packet &p);

  virtual NetworkRecvStatus ReceiveServerCompanyUpdate(Packet &p);

  virtual NetworkRecvStatus ReceiveServerCompanyRemove(Packet &p);

  virtual NetworkRecvStatus ReceiveServerCompanyEconomy(Packet &p);

  virtual NetworkRecvStatus ReceiveServerCompanyStatistics(Packet &p);

  virtual NetworkRecvStatus ReceiveServerChat(Packet &p);

  virtual NetworkRecvStatus ReceiveServerRemoteConsoleCommand(Packet &p);

  virtual NetworkRecvStatus ReceiveServerConsole(Packet &p);

  virtual NetworkRecvStatus ReceiveServerCommandNames(Packet &p);

  virtual NetworkRecvStatus ReceiveServerCommandLogging(Packet &p);

  virtual NetworkRecvStatus ReceiveServerAuthenticationRequest(Packet &p);

  virtual NetworkRecvStatus ReceiveServerEnableEncryption(Packet &p);

  virtual NetworkRecvStatus ReceiveServerPong(Packet &p);

  virtual NetworkRecvStatus ReceiveServerRemoteConsoleCommandEnd(Packet &p);
 
  NetworkRecvStatus HandlePacket(Packet &p);
public:
  NetworkRecvStatus CloseConnection(bool error = true) override;

  NetworkAdminSocketHandler(SOCKET s) : NetworkTCPSocketHandler(s) {}
 
  NetworkRecvStatus ReceivePackets();

  AdminStatus GetAdminStatus() const
  {
    return this->status;
  }
};
 
#endif /* NETWORK_CORE_TCP_ADMIN_H */