(svn r20970) -Add: company change notification to remote admins (dihedral)

5 files changed, 213 insertions, 0 deletions

diff --git a/src/network/core/tcp_admin.cpp b/src/network/core/tcp_admin.cpp
index ee254968a..41855feeb 100644
--- a/src/network/core/tcp_admin.cpp
+++ b/src/network/core/tcp_admin.cpp
@@ -69,6 +69,10 @@ NetworkRecvStatus NetworkAdminSocketHandler::HandlePacket(Packet *p)
 		ADMIN_COMMAND(ADMIN_PACKET_SERVER_CLIENT_UPDATE)
 		ADMIN_COMMAND(ADMIN_PACKET_SERVER_CLIENT_QUIT)
 		ADMIN_COMMAND(ADMIN_PACKET_SERVER_CLIENT_ERROR)
+		ADMIN_COMMAND(ADMIN_PACKET_SERVER_COMPANY_NEW)
+		ADMIN_COMMAND(ADMIN_PACKET_SERVER_COMPANY_INFO)
+		ADMIN_COMMAND(ADMIN_PACKET_SERVER_COMPANY_UPDATE)
+		ADMIN_COMMAND(ADMIN_PACKET_SERVER_COMPANY_REMOVE)
 
 		default:
 			if (this->HasClientQuit()) {
@@ -133,5 +137,9 @@ DEFINE_UNAVAILABLE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_CLIENT_INFO)
 DEFINE_UNAVAILABLE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_CLIENT_UPDATE)
 DEFINE_UNAVAILABLE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_CLIENT_QUIT)
 DEFINE_UNAVAILABLE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_CLIENT_ERROR)
+DEFINE_UNAVAILABLE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_COMPANY_NEW)
+DEFINE_UNAVAILABLE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_COMPANY_INFO)
+DEFINE_UNAVAILABLE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_COMPANY_UPDATE)
+DEFINE_UNAVAILABLE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_COMPANY_REMOVE)
 
 #endif /* ENABLE_NETWORK */
diff --git a/src/network/core/tcp_admin.h b/src/network/core/tcp_admin.h
index 656fa9503..fdd9cf81c 100644
--- a/src/network/core/tcp_admin.h
+++ b/src/network/core/tcp_admin.h
@@ -45,6 +45,10 @@ enum PacketAdminType {
 	ADMIN_PACKET_SERVER_CLIENT_UPDATE,   ///< The server gives the admin an information update on a client.
 	ADMIN_PACKET_SERVER_CLIENT_QUIT,     ///< The server tells the admin that a client quit.
 	ADMIN_PACKET_SERVER_CLIENT_ERROR,    ///< The server tells the admin that a client caused an error.
+	ADMIN_PACKET_SERVER_COMPANY_NEW,     ///< The server tells the admin that a new company has started.
+	ADMIN_PACKET_SERVER_COMPANY_INFO,    ///< The server gives the admin information about a company.
+	ADMIN_PACKET_SERVER_COMPANY_UPDATE,  ///< The server gives the admin an information update on a company.
+	ADMIN_PACKET_SERVER_COMPANY_REMOVE,  ///< The server tells the admin that a company was removed.
 
 	INVALID_ADMIN_PACKET = 0xFF,         ///< An invalid marker for admin packets.
 };
@@ -60,6 +64,7 @@ enum AdminStatus {
 enum AdminUpdateType {
 	ADMIN_UPDATE_DATE,            ///< Updates about the date of the game.
 	ADMIN_UPDATE_CLIENT_INFO,     ///< Updates about the information of clients.
+	ADMIN_UPDATE_COMPANY_INFO,    ///< Updates about the generic information of companies.
 	ADMIN_UPDATE_END              ///< Must ALWAYS be on the end of this list!! (period)
 };
 
@@ -75,6 +80,13 @@ enum AdminUpdateFrequency {
 };
 DECLARE_ENUM_AS_BIT_SET(AdminUpdateFrequency);
 
+/** Reasons for removing a company - communicated to admins. */
+enum AdminCompanyRemoveReason {
+	ADMIN_CRR_MANUAL,    ///< The company is manually removed.
+	ADMIN_CRR_AUTOCLEAN, ///< The company is removed due to autoclean.
+	ADMIN_CRR_BANKRUPT   ///< The company went belly-up.
+};
+
 #define DECLARE_ADMIN_RECEIVE_COMMAND(type) virtual NetworkRecvStatus NetworkPacketReceive_## type ##_command(Packet *p)
 #define DEF_ADMIN_RECEIVE_COMMAND(cls, type) NetworkRecvStatus cls ##NetworkAdminSocketHandler::NetworkPacketReceive_ ## type ## _command(Packet *p)
 
@@ -110,6 +122,7 @@ protected:
 	 * uint8   #AdminUpdateType the server should answer for, only if #AdminUpdateFrequency #ADMIN_FREQUENCY_POLL is advertised in the PROTOCOL packet.
 	 * uint32  ID relevant to the packet type, e.g.
 	 *          - the client ID for #ADMIN_UPDATE_CLIENT_INFO. Use UINT32_MAX to show all clients.
+	 *          - the company ID for #ADMIN_UPDATE_COMPANY_INFO. Use UINT32_MAX to show all companies.
 	 */
 	DECLARE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_ADMIN_POLL);
 
@@ -206,6 +219,46 @@ protected:
 	 */
 	DECLARE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_CLIENT_ERROR);
 
+	/**
+	 * Notification of a new company:
+	 * uint8   ID of the new company.
+	 */
+	DECLARE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_COMPANY_NEW);
+
+	/**
+	 * Company information on a specific company:
+	 * uint8   ID of the company.
+	 * string  Name of the company.
+	 * string  Name of the companies manager.
+	 * uint8   Main company colour.
+	 * bool    Company is password protected.
+	 * uint32  Year the company was inaugurated.
+	 * bool    Company is an AI.
+	 */
+	DECLARE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_COMPANY_INFO);
+
+	/**
+	 * Company information of a specific company:
+	 * uint8   ID of the company.
+	 * string  Name of the company.
+	 * string  Name of the companies manager.
+	 * uint8   Main company colour.
+	 * bool    Company is password protected.
+	 * uint8   Quarters of bankruptcy.
+	 * uint8   Owner of share 1.
+	 * uint8   Owner of share 2.
+	 * uint8   Owner of share 3.
+	 * uint8   Owner of share 4.
+	 */
+	DECLARE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_COMPANY_UPDATE);
+
+	/**
+	 * Notification about a removed company (e.g. due to banrkuptcy).
+	 * uint8   ID of the company.
+	 * uint8   Reason for being removed (see #AdminCompanyRemoveReason).
+	 */
+	DECLARE_ADMIN_RECEIVE_COMMAND(ADMIN_PACKET_SERVER_COMPANY_REMOVE);
+
 	NetworkRecvStatus HandlePacket(Packet *p);
 public:
 	NetworkRecvStatus CloseConnection(bool error = true);
diff --git a/src/network/network_admin.cpp b/src/network/network_admin.cpp
index 9e6402310..b6341ed20 100644
--- a/src/network/network_admin.cpp
+++ b/src/network/network_admin.cpp
@@ -42,6 +42,7 @@ static const int ADMIN_AUTHORISATION_TIMEOUT = 10000;
 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
 };
 assert_compile(lengthof(_admin_update_type_frequencies) == ADMIN_UPDATE_END);
 
@@ -241,6 +242,83 @@ NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientError(ClientID clie
 	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->Send_Packet(p);
+
+	return NETWORK_RECV_STATUS_OKAY;
+}
+
+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);
+
+	this->Send_Packet(p);
+
+	return NETWORK_RECV_STATUS_OKAY;
+}
+
+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 (c->quarters_of_bankruptcy);
+
+	for (size_t i = 0; i < lengthof(c->share_owners); i++) {
+		p->Send_uint8(c->share_owners[i]);
+	}
+
+	this->Send_Packet(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->Send_Packet(p);
+
+	return NETWORK_RECV_STATUS_OKAY;
+}
+
 /***********
  * Receiving functions
  ************/
@@ -321,6 +399,19 @@ DEF_ADMIN_RECEIVE_COMMAND(Server, ADMIN_PACKET_ADMIN_POLL)
 			}
 			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;
+
 		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);
@@ -396,6 +487,58 @@ void NetworkAdminClientError(ClientID client_id, NetworkErrorCode 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_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_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_ADMIN_SOCKETS(as) {
+		as->SendCompanyRemove(company_id, bcrr);
+	}
+}
+
+/**
  * Send a Welcome packet to all connected admins
  */
 void ServerNetworkAdminSocketHandler::WelcomeAll()
diff --git a/src/network/network_admin.h b/src/network/network_admin.h
index 384553081..96b9f74e2 100644
--- a/src/network/network_admin.h
+++ b/src/network/network_admin.h
@@ -49,6 +49,10 @@ public:
 	NetworkRecvStatus SendClientUpdate(const NetworkClientInfo *ci);
 	NetworkRecvStatus SendClientQuit(ClientID client_id);
 	NetworkRecvStatus SendClientError(ClientID client_id, NetworkErrorCode error);
+	NetworkRecvStatus SendCompanyNew(CompanyID company_id);
+	NetworkRecvStatus SendCompanyInfo(const Company *c);
+	NetworkRecvStatus SendCompanyUpdate(const Company *c);
+	NetworkRecvStatus SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr);
 
 	static void Send();
 	static void AcceptConnection(SOCKET s, const NetworkAddress &address);
@@ -72,6 +76,9 @@ void NetworkAdminClientInfo(const NetworkClientInfo *ci, bool new_client = false
 void NetworkAdminClientUpdate(const NetworkClientInfo *ci);
 void NetworkAdminClientQuit(ClientID client_id);
 void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code);
+void NetworkAdminCompanyInfo(const Company *company, bool new_company);
+void NetworkAdminCompanyUpdate(const Company *company);
+void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr);
 void NetworkAdminUpdate(AdminUpdateFrequency freq);
 
 #endif /* ENABLE_NETWORK */
diff --git a/src/network/network_server.cpp b/src/network/network_server.cpp
index 0a49a277b..c49c9ed88 100644
--- a/src/network/network_server.cpp
+++ b/src/network/network_server.cpp
@@ -1544,6 +1544,7 @@ static void NetworkAutoCleanCompanies()
 			if (_settings_client.network.autoclean_unprotected != 0 && _network_company_states[c->index].months_empty > _settings_client.network.autoclean_unprotected && StrEmpty(_network_company_states[c->index].password)) {
 				/* Shut the company down */
 				DoCommandP(0, 2 | c->index << 16, 0, CMD_COMPANY_CTRL);
+				NetworkAdminCompanyRemove(c->index, ADMIN_CRR_AUTOCLEAN);
 				IConsolePrintF(CC_DEFAULT, "Auto-cleaned company #%d with no password", c->index + 1);
 			}
 			/* Is the company empty for autoclean_protected-months, and there is a protection? */
@@ -1558,6 +1559,7 @@ static void NetworkAutoCleanCompanies()
 			if (_settings_client.network.autoclean_novehicles != 0 && _network_company_states[c->index].months_empty > _settings_client.network.autoclean_novehicles && vehicles_in_company[c->index] == 0) {
 				/* Shut the company down */
 				DoCommandP(0, 2 | c->index << 16, 0, CMD_COMPANY_CTRL);
+				NetworkAdminCompanyRemove(c->index, ADMIN_CRR_AUTOCLEAN);
 				IConsolePrintF(CC_DEFAULT, "Auto-cleaned company #%d with no vehicles", c->index + 1);
 			}
 		} else {