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 PacketAdminType : uint8_t {
  ADMIN_PACKET_ADMIN_JOIN,             
  ADMIN_PACKET_ADMIN_QUIT,             
  ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY, 
  ADMIN_PACKET_ADMIN_POLL,             
  ADMIN_PACKET_ADMIN_CHAT,             
  ADMIN_PACKET_ADMIN_RCON,             
  ADMIN_PACKET_ADMIN_GAMESCRIPT,       
  ADMIN_PACKET_ADMIN_PING,             
  ADMIN_PACKET_ADMIN_EXTERNAL_CHAT,    
  ADMIN_PACKET_ADMIN_JOIN_SECURE,      
  ADMIN_PACKET_ADMIN_AUTH_RESPONSE,    
 
  ADMIN_PACKET_SERVER_FULL = 100,      
  ADMIN_PACKET_SERVER_BANNED,          
  ADMIN_PACKET_SERVER_ERROR,           
  ADMIN_PACKET_SERVER_PROTOCOL,        
  ADMIN_PACKET_SERVER_WELCOME,         
  ADMIN_PACKET_SERVER_NEWGAME,         
  ADMIN_PACKET_SERVER_SHUTDOWN,        
 
  ADMIN_PACKET_SERVER_DATE,            
  ADMIN_PACKET_SERVER_CLIENT_JOIN,     
  ADMIN_PACKET_SERVER_CLIENT_INFO,     
  ADMIN_PACKET_SERVER_CLIENT_UPDATE,   
  ADMIN_PACKET_SERVER_CLIENT_QUIT,     
  ADMIN_PACKET_SERVER_CLIENT_ERROR,    
  ADMIN_PACKET_SERVER_COMPANY_NEW,     
  ADMIN_PACKET_SERVER_COMPANY_INFO,    
  ADMIN_PACKET_SERVER_COMPANY_UPDATE,  
  ADMIN_PACKET_SERVER_COMPANY_REMOVE,  
  ADMIN_PACKET_SERVER_COMPANY_ECONOMY, 
  ADMIN_PACKET_SERVER_COMPANY_STATS,   
  ADMIN_PACKET_SERVER_CHAT,            
  ADMIN_PACKET_SERVER_RCON,            
  ADMIN_PACKET_SERVER_CONSOLE,         
  ADMIN_PACKET_SERVER_CMD_NAMES,       
  ADMIN_PACKET_SERVER_CMD_LOGGING_OLD, 
  ADMIN_PACKET_SERVER_GAMESCRIPT,      
  ADMIN_PACKET_SERVER_RCON_END,        
  ADMIN_PACKET_SERVER_PONG,            
  ADMIN_PACKET_SERVER_CMD_LOGGING,     
  ADMIN_PACKET_SERVER_AUTH_REQUEST,    
  ADMIN_PACKET_SERVER_ENABLE_ENCRYPTION, 
 
  INVALID_ADMIN_PACKET = 0xFF,         
};

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 Receive_ADMIN_JOIN(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_QUIT(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_POLL(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_CHAT(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_EXTERNAL_CHAT(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_RCON(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_PING(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_JOIN_SECURE(Packet &p);

  virtual NetworkRecvStatus Receive_ADMIN_AUTH_RESPONSE(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_FULL(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_BANNED(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_ERROR(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_PROTOCOL(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_WELCOME(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_NEWGAME(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_SHUTDOWN(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_DATE(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CLIENT_JOIN(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CLIENT_INFO(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CLIENT_UPDATE(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CLIENT_QUIT(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CLIENT_ERROR(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_COMPANY_NEW(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_COMPANY_INFO(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_COMPANY_UPDATE(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_COMPANY_REMOVE(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_COMPANY_ECONOMY(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_COMPANY_STATS(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CHAT(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_RCON(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CONSOLE(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CMD_NAMES(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_CMD_LOGGING(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_AUTH_REQUEST(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_ENABLE_ENCRYPTION(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_PONG(Packet &p);

  virtual NetworkRecvStatus Receive_SERVER_RCON_END(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 */