OpenTTD Source  1.11.2
network_admin.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #include "../stdafx.h"
11 #include "../strings_func.h"
12 #include "../date_func.h"
13 #include "core/game_info.h"
14 #include "network_admin.h"
15 #include "network_base.h"
16 #include "network_server.h"
17 #include "../command_func.h"
18 #include "../company_base.h"
19 #include "../console_func.h"
20 #include "../core/pool_func.hpp"
21 #include "../map_func.h"
22 #include "../rev.h"
23 #include "../game/game.hpp"
24 
25 #include "../safeguards.h"
26 
27 
28 /* This file handles all the admin network commands. */
29 
32 
35 
38 INSTANTIATE_POOL_METHODS(NetworkAdminSocket)
39 
40 
41 static const std::chrono::seconds ADMIN_AUTHORISATION_TIMEOUT(10);
42 
43 
56 };
59 
65 {
68  this->connect_time = std::chrono::steady_clock::now();
69 }
70 
75 {
77  DEBUG(net, 1, "[admin] '%s' (%s) has disconnected", this->admin_name, this->admin_version);
79 }
80 
86 {
88  /* We can't go over the MAX_ADMINS limit here. However, if we accept
89  * the connection, there has to be space in the pool. */
92  return accept;
93 }
94 
97 {
99  if (as->status == ADMIN_STATUS_INACTIVE && std::chrono::steady_clock::now() > as->connect_time + ADMIN_AUTHORISATION_TIMEOUT) {
100  DEBUG(net, 1, "[admin] Admin did not send its authorisation within %d seconds", (uint32)std::chrono::duration_cast<std::chrono::seconds>(ADMIN_AUTHORISATION_TIMEOUT).count());
101  as->CloseConnection(true);
102  continue;
103  }
104  if (as->writable) {
105  as->SendPackets();
106  }
107  }
108 }
109 
115 /* static */ void ServerNetworkAdminSocketHandler::AcceptConnection(SOCKET s, const NetworkAddress &address)
116 {
118  as->address = address; // Save the IP of the client
119 }
120 
121 /***********
122  * Sending functions for admin network
123  ************/
124 
130 {
132 
133  p->Send_uint8(error);
134  this->SendPacket(p);
135 
136  char str[100];
138  GetString(str, strid, lastof(str));
139 
140  DEBUG(net, 1, "[admin] the admin '%s' (%s) made an error and has been disconnected. Reason: '%s'", this->admin_name, this->admin_version, str);
141 
142  return this->CloseConnection(true);
143 }
144 
147 {
149 
150  /* announce the protocol version */
152 
153  for (int i = 0; i < ADMIN_UPDATE_END; i++) {
154  p->Send_bool (true);
155  p->Send_uint16(i);
157  }
158 
159  p->Send_bool(false);
160  this->SendPacket(p);
161 
162  return this->SendWelcome();
163 }
164 
167 {
169 
173 
178  p->Send_uint16(MapSizeX());
179  p->Send_uint16(MapSizeY());
180 
181  this->SendPacket(p);
182 
184 }
185 
188 {
190  this->SendPacket(p);
192 }
193 
196 {
198  this->SendPacket(p);
200 }
201 
204 {
206 
207  p->Send_uint32(_date);
208  this->SendPacket(p);
209 
211 }
212 
218 {
220 
221  p->Send_uint32(client_id);
222  this->SendPacket(p);
223 
225 }
226 
233 {
234  /* Only send data when we're a proper client, not just someone trying to query the server. */
235  if (ci == nullptr) return NETWORK_RECV_STATUS_OKAY;
236 
238 
239  p->Send_uint32(ci->client_id);
240  p->Send_string(cs == nullptr ? "" : const_cast<NetworkAddress &>(cs->client_address).GetHostname());
241  p->Send_string(ci->client_name);
242  p->Send_uint8 (ci->client_lang);
243  p->Send_uint32(ci->join_date);
244  p->Send_uint8 (ci->client_playas);
245 
246  this->SendPacket(p);
247 
249 }
250 
251 
257 {
259 
260  p->Send_uint32(ci->client_id);
261  p->Send_string(ci->client_name);
262  p->Send_uint8 (ci->client_playas);
263 
264  this->SendPacket(p);
265 
267 }
268 
274 {
276 
277  p->Send_uint32(client_id);
278  this->SendPacket(p);
279 
281 }
282 
289 {
291 
292  p->Send_uint32(client_id);
293  p->Send_uint8 (error);
294  this->SendPacket(p);
295 
297 }
298 
304 {
306  p->Send_uint8(company_id);
307 
308  this->SendPacket(p);
309 
311 }
312 
318 {
319  char company_name[NETWORK_COMPANY_NAME_LENGTH];
320  char manager_name[NETWORK_COMPANY_NAME_LENGTH];
321 
322  SetDParam(0, c->index);
323  GetString(company_name, STR_COMPANY_NAME, lastof(company_name));
324 
325  SetDParam(0, c->index);
326  GetString(manager_name, STR_PRESIDENT_NAME, lastof(manager_name));
327 
329 
330  p->Send_uint8 (c->index);
331  p->Send_string(company_name);
332  p->Send_string(manager_name);
333  p->Send_uint8 (c->colour);
336  p->Send_bool (c->is_ai);
337  p->Send_uint8 (CeilDiv(c->months_of_bankruptcy, 3)); // send as quarters_of_bankruptcy
338 
339  for (size_t i = 0; i < lengthof(c->share_owners); i++) {
340  p->Send_uint8(c->share_owners[i]);
341  }
342 
343  this->SendPacket(p);
344 
346 }
347 
348 
354 {
355  char company_name[NETWORK_COMPANY_NAME_LENGTH];
356  char manager_name[NETWORK_COMPANY_NAME_LENGTH];
357 
358  SetDParam(0, c->index);
359  GetString(company_name, STR_COMPANY_NAME, lastof(company_name));
360 
361  SetDParam(0, c->index);
362  GetString(manager_name, STR_PRESIDENT_NAME, lastof(manager_name));
363 
365 
366  p->Send_uint8 (c->index);
367  p->Send_string(company_name);
368  p->Send_string(manager_name);
369  p->Send_uint8 (c->colour);
371  p->Send_uint8 (CeilDiv(c->months_of_bankruptcy, 3)); // send as quarters_of_bankruptcy
372 
373  for (size_t i = 0; i < lengthof(c->share_owners); i++) {
374  p->Send_uint8(c->share_owners[i]);
375  }
376 
377  this->SendPacket(p);
378 
380 }
381 
388 {
390 
391  p->Send_uint8(company_id);
392  p->Send_uint8(acrr);
393 
394  this->SendPacket(p);
395 
397 }
398 
401 {
402  for (const Company *company : Company::Iterate()) {
403  /* Get the income. */
404  Money income = 0;
405  for (uint i = 0; i < lengthof(company->yearly_expenses[0]); i++) {
406  income -= company->yearly_expenses[0][i];
407  }
408 
410 
411  p->Send_uint8(company->index);
412 
413  /* Current information. */
414  p->Send_uint64(company->money);
415  p->Send_uint64(company->current_loan);
416  p->Send_uint64(income);
417  p->Send_uint16(static_cast<uint16>(std::min<uint64>(UINT16_MAX, company->cur_economy.delivered_cargo.GetSum<OverflowSafeInt64>())));
418 
419  /* Send stats for the last 2 quarters. */
420  for (uint i = 0; i < 2; i++) {
421  p->Send_uint64(company->old_economy[i].company_value);
422  p->Send_uint16(company->old_economy[i].performance_history);
423  p->Send_uint16(static_cast<uint16>(std::min<uint64>(UINT16_MAX, company->old_economy[i].delivered_cargo.GetSum<OverflowSafeInt64>())));
424  }
425 
426  this->SendPacket(p);
427  }
428 
429 
431 }
432 
435 {
436  /* Fetch the latest version of the stats. */
437  NetworkCompanyStats company_stats[MAX_COMPANIES];
438  NetworkPopulateCompanyStats(company_stats);
439 
440  /* Go through all the companies. */
441  for (const Company *company : Company::Iterate()) {
443 
444  /* Send the information. */
445  p->Send_uint8(company->index);
446 
447  for (uint i = 0; i < NETWORK_VEH_END; i++) {
448  p->Send_uint16(company_stats[company->index].num_vehicle[i]);
449  }
450 
451  for (uint i = 0; i < NETWORK_VEH_END; i++) {
452  p->Send_uint16(company_stats[company->index].num_station[i]);
453  }
454 
455  this->SendPacket(p);
456  }
457 
459 }
460 
469 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data)
470 {
472 
473  p->Send_uint8 (action);
474  p->Send_uint8 (desttype);
475  p->Send_uint32(client_id);
476  p->Send_string(msg);
477  p->Send_uint64(data);
478 
479  this->SendPacket(p);
481 }
482 
488 {
490 
491  p->Send_string(command);
492  this->SendPacket(p);
493 
495 }
496 
503 {
505 
506  p->Send_uint16(colour);
507  p->Send_string(result);
508  this->SendPacket(p);
509 
511 }
512 
514 {
515  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
516 
517  char command[NETWORK_RCONCOMMAND_LENGTH];
518 
519  p->Recv_string(command, sizeof(command));
520 
521  DEBUG(net, 2, "[admin] Rcon command from '%s' (%s): '%s'", this->admin_name, this->admin_version, command);
522 
524  IConsoleCmdExec(command);
526  return this->SendRconEnd(command);
527 }
528 
530 {
531  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
532 
534 
535  p->Recv_string(json, sizeof(json));
536 
537  DEBUG(net, 2, "[admin] GameScript JSON from '%s' (%s): '%s'", this->admin_name, this->admin_version, json);
538 
539  Game::NewEvent(new ScriptEventAdminPort(json));
541 }
542 
544 {
545  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
546 
547  uint32 d1 = p->Recv_uint32();
548 
549  DEBUG(net, 2, "[admin] Ping from '%s' (%s): '%d'", this->admin_name, this->admin_version, d1);
550 
551  return this->SendPong(d1);
552 }
553 
560 {
561  /* If the length of both strings, plus the 2 '\0' terminations and 3 bytes of the packet
562  * are bigger than the MTU, just ignore the message. Better safe than sorry. It should
563  * never occur though as the longest strings are chat messages, which are still 30%
564  * smaller than SEND_MTU. */
565  if (strlen(origin) + strlen(string) + 2 + 3 >= SEND_MTU) return NETWORK_RECV_STATUS_OKAY;
566 
568 
569  p->Send_string(origin);
570  p->Send_string(string);
571  this->SendPacket(p);
572 
574 }
575 
581 {
582  /* At the moment we cannot transmit anything larger than MTU. So we limit
583  * the maximum amount of json data that can be sent. Account also for
584  * the trailing \0 of the string */
585  if (strlen(json) + 1 >= NETWORK_GAMESCRIPT_JSON_LENGTH) return NETWORK_RECV_STATUS_OKAY;
586 
588 
589  p->Send_string(json);
590  this->SendPacket(p);
591 
593 }
594 
597 {
599 
600  p->Send_uint32(d1);
601  this->SendPacket(p);
602 
604 }
605 
608 {
610 
611  for (uint i = 0; i < CMD_END; i++) {
612  const char *cmdname = GetCommandName(i);
613 
614  /* Should SEND_MTU be exceeded, start a new packet
615  * (magic 5: 1 bool "more data" and one uint16 "command id", one
616  * byte for string '\0' termination and 1 bool "no more data" */
617  if (p->size + strlen(cmdname) + 5 >= SEND_MTU) {
618  p->Send_bool(false);
619  this->SendPacket(p);
620 
622  }
623 
624  p->Send_bool(true);
625  p->Send_uint16(i);
626  p->Send_string(cmdname);
627  }
628 
629  /* Marker to notify the end of the packet has been reached. */
630  p->Send_bool(false);
631  this->SendPacket(p);
632 
634 }
635 
642 {
644 
645  p->Send_uint32(client_id);
646  p->Send_uint8 (cp->company);
647  p->Send_uint16(cp->cmd & CMD_ID_MASK);
648  p->Send_uint32(cp->p1);
649  p->Send_uint32(cp->p2);
650  p->Send_uint32(cp->tile);
651  p->Send_string(cp->text);
652  p->Send_uint32(cp->frame);
653 
654  this->SendPacket(p);
655 
657 }
658 
659 /***********
660  * Receiving functions
661  ************/
662 
664 {
665  if (this->status != ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
666 
667  char password[NETWORK_PASSWORD_LENGTH];
668  p->Recv_string(password, sizeof(password));
669 
671  strcmp(password, _settings_client.network.admin_password) != 0) {
672  /* Password is invalid */
673  return this->SendError(NETWORK_ERROR_WRONG_PASSWORD);
674  }
675 
676  p->Recv_string(this->admin_name, sizeof(this->admin_name));
677  p->Recv_string(this->admin_version, sizeof(this->admin_version));
678 
679  if (StrEmpty(this->admin_name) || StrEmpty(this->admin_version)) {
680  /* no name or version supplied */
681  return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
682  }
683 
684  this->status = ADMIN_STATUS_ACTIVE;
685 
686  DEBUG(net, 1, "[admin] '%s' (%s) has connected", this->admin_name, this->admin_version);
687 
688  return this->SendProtocol();
689 }
690 
692 {
693  /* The admin is leaving nothing else to do */
694  return this->CloseConnection();
695 }
696 
698 {
699  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
700 
703 
704  if (type >= ADMIN_UPDATE_END || (_admin_update_type_frequencies[type] & freq) != freq) {
705  /* The server does not know of this UpdateType. */
706  DEBUG(net, 3, "[admin] Not supported update frequency %d (%d) from '%s' (%s).", type, freq, this->admin_name, this->admin_version);
707  return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
708  }
709 
710  this->update_frequency[type] = freq;
711 
713 }
714 
716 {
717  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
718 
720  uint32 d1 = p->Recv_uint32();
721 
722  switch (type) {
723  case ADMIN_UPDATE_DATE:
724  /* The admin is requesting the current date. */
725  this->SendDate();
726  break;
727 
729  /* The admin is requesting client info. */
730  if (d1 == UINT32_MAX) {
732  for (const NetworkClientSocket *cs : NetworkClientSocket::Iterate()) {
733  this->SendClientInfo(cs, cs->GetInfo());
734  }
735  } else {
736  if (d1 == CLIENT_ID_SERVER) {
738  } else {
739  const NetworkClientSocket *cs = NetworkClientSocket::GetByClientID((ClientID)d1);
740  if (cs != nullptr) this->SendClientInfo(cs, cs->GetInfo());
741  }
742  }
743  break;
744 
746  /* The admin is asking for company info. */
747  if (d1 == UINT32_MAX) {
748  for (const Company *company : Company::Iterate()) {
749  this->SendCompanyInfo(company);
750  }
751  } else {
752  const Company *company = Company::GetIfValid(d1);
753  if (company != nullptr) this->SendCompanyInfo(company);
754  }
755  break;
756 
758  /* The admin is requesting economy info. */
759  this->SendCompanyEconomy();
760  break;
761 
763  /* the admin is requesting company stats. */
764  this->SendCompanyStats();
765  break;
766 
768  /* The admin is requesting the names of DoCommands. */
769  this->SendCmdNames();
770  break;
771 
772  default:
773  /* An unsupported "poll" update type. */
774  DEBUG(net, 3, "[admin] Not supported poll %d (%d) from '%s' (%s).", type, d1, this->admin_name, this->admin_version);
775  return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
776  }
777 
779 }
780 
782 {
783  if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
784 
785  NetworkAction action = (NetworkAction)p->Recv_uint8();
786  DestType desttype = (DestType)p->Recv_uint8();
787  int dest = p->Recv_uint32();
788 
789  char msg[NETWORK_CHAT_LENGTH];
791 
792  switch (action) {
793  case NETWORK_ACTION_CHAT:
794  case NETWORK_ACTION_CHAT_CLIENT:
795  case NETWORK_ACTION_CHAT_COMPANY:
796  case NETWORK_ACTION_SERVER_MESSAGE:
797  NetworkServerSendChat(action, desttype, dest, msg, _network_own_client_id, 0, true);
798  break;
799 
800  default:
801  DEBUG(net, 3, "[admin] Invalid chat action %d from admin '%s' (%s).", action, this->admin_name, this->admin_version);
802  return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
803  }
804 
806 }
807 
808 /*
809  * Useful wrapper functions
810  */
811 
817 void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client)
818 {
820  if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
821  as->SendClientInfo(cs, cs->GetInfo());
822  if (new_client) {
823  as->SendClientJoin(cs->client_id);
824  }
825  }
826  }
827 }
828 
834 {
836  if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
837  as->SendClientUpdate(ci);
838  }
839  }
840 }
841 
847 {
849  if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
850  as->SendClientQuit(client_id);
851  }
852  }
853 }
854 
861 {
863  if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
864  as->SendClientError(client_id, error_code);
865  }
866  }
867 }
868 
874 void NetworkAdminCompanyInfo(const Company *company, bool new_company)
875 {
876  if (company == nullptr) {
877  DEBUG(net, 1, "[admin] Empty company given for update");
878  return;
879  }
880 
882  if (as->update_frequency[ADMIN_UPDATE_COMPANY_INFO] != ADMIN_FREQUENCY_AUTOMATIC) continue;
883 
884  as->SendCompanyInfo(company);
885  if (new_company) {
886  as->SendCompanyNew(company->index);
887  }
888  }
889 }
890 
895 void NetworkAdminCompanyUpdate(const Company *company)
896 {
897  if (company == nullptr) return;
898 
900  if (as->update_frequency[ADMIN_UPDATE_COMPANY_INFO] != ADMIN_FREQUENCY_AUTOMATIC) continue;
901 
902  as->SendCompanyUpdate(company);
903  }
904 }
905 
912 {
914  as->SendCompanyRemove(company_id, bcrr);
915  }
916 }
917 
918 
922 void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data, bool from_admin)
923 {
924  if (from_admin) return;
925 
927  if (as->update_frequency[ADMIN_UPDATE_CHAT] & ADMIN_FREQUENCY_AUTOMATIC) {
928  as->SendChat(action, desttype, client_id, msg, data);
929  }
930  }
931 }
932 
939 void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const char *string)
940 {
941  ServerNetworkAdminSocketHandler::Get(admin_index)->SendRcon(colour_code, string);
942 }
943 
949 void NetworkAdminConsole(const char *origin, const char *string)
950 {
952  if (as->update_frequency[ADMIN_UPDATE_CONSOLE] & ADMIN_FREQUENCY_AUTOMATIC) {
953  as->SendConsole(origin, string);
954  }
955  }
956 }
957 
962 void NetworkAdminGameScript(const char *json)
963 {
965  if (as->update_frequency[ADMIN_UPDATE_GAMESCRIPT] & ADMIN_FREQUENCY_AUTOMATIC) {
966  as->SendGameScript(json);
967  }
968  }
969 }
970 
976 void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp)
977 {
978  ClientID client_id = owner == nullptr ? _network_own_client_id : owner->client_id;
979 
981  if (as->update_frequency[ADMIN_UPDATE_CMD_LOGGING] & ADMIN_FREQUENCY_AUTOMATIC) {
982  as->SendCmdLogging(client_id, cp);
983  }
984  }
985 }
986 
991 {
993  as->SendWelcome();
994  }
995 }
996 
1002 {
1004  for (int i = 0; i < ADMIN_UPDATE_END; i++) {
1005  if (as->update_frequency[i] & freq) {
1006  /* Update the admin for the required details */
1007  switch (i) {
1008  case ADMIN_UPDATE_DATE:
1009  as->SendDate();
1010  break;
1011 
1013  as->SendCompanyEconomy();
1014  break;
1015 
1017  as->SendCompanyStats();
1018  break;
1019 
1020  default: NOT_REACHED();
1021  }
1022  }
1023  }
1024  }
1025 }
NetworkCompanyStats::num_station
uint16 num_station[NETWORK_VEH_END]
How many stations are there of this type?
Definition: network_type.h:59
ADMIN_PACKET_SERVER_GAMESCRIPT
@ ADMIN_PACKET_SERVER_GAMESCRIPT
The server gives the admin information from the GameScript in JSON.
Definition: tcp_admin.h:59
ServerNetworkAdminSocketHandler::SendGameScript
NetworkRecvStatus SendGameScript(const char *json)
Send GameScript JSON output.
Definition: network_admin.cpp:580
CompanyProperties::is_ai
bool is_ai
If true, the company is (also) controlled by the computer (a NoAI program).
Definition: company_base.h:94
NetworkCompanyStats
Simple calculated statistics of a company.
Definition: network_type.h:57
CommandContainer::cmd
uint32 cmd
command being executed.
Definition: command_type.h:483
DestType
DestType
Destination of our chat messages.
Definition: network_type.h:81
ADMIN_UPDATE_CMD_NAMES
@ ADMIN_UPDATE_CMD_NAMES
The admin would like a list of all DoCommand names.
Definition: tcp_admin.h:82
ADMIN_UPDATE_COMPANY_INFO
@ ADMIN_UPDATE_COMPANY_INFO
Updates about the generic information of companies.
Definition: tcp_admin.h:77
ServerNetworkAdminSocketHandler::Receive_ADMIN_UPDATE_FREQUENCY
NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY(Packet *p) override
Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet): uint16 Upda...
Definition: network_admin.cpp:697
GameCreationSettings::generation_seed
uint32 generation_seed
noise seed for world generation
Definition: settings_type.h:292
ServerNetworkAdminSocketHandler::SendConsole
NetworkRecvStatus SendConsole(const char *origin, const char *command)
Send console output of other clients.
Definition: network_admin.cpp:559
Pool::PoolItem<&_networkadminsocket_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:329
NetworkAdminUpdate
void NetworkAdminUpdate(AdminUpdateFrequency freq)
Send (push) updates to the admin network as they have registered for these updates.
Definition: network_admin.cpp:1001
Packet::Recv_string
void Recv_string(char *buffer, size_t size, StringValidationSettings settings=SVS_REPLACE_WITH_QUESTION_MARK)
Reads a string till it finds a '\0' in the stream.
Definition: packet.cpp:286
NetworkAdminSocketHandler::status
AdminStatus status
Status of this admin.
Definition: tcp_admin.h:114
NetworkAdminSocketHandler::CloseConnection
NetworkRecvStatus CloseConnection(bool error=true) override
Close the current connection; for TCP this will be mostly equivalent to Close(), but for UDP it just ...
Definition: tcp_admin.cpp:41
Pool::PoolItem<&_company_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:340
GameCreationSettings::landscape
byte landscape
the landscape we're currently in
Definition: settings_type.h:308
ADMIN_PACKET_SERVER_CLIENT_QUIT
@ ADMIN_PACKET_SERVER_CLIENT_QUIT
The server tells the admin that a client quit.
Definition: tcp_admin.h:46
ServerNetworkAdminSocketHandler::SendError
NetworkRecvStatus SendError(NetworkErrorCode error)
Send an error to the admin.
Definition: network_admin.cpp:129
ADMIN_UPDATE_CLIENT_INFO
@ ADMIN_UPDATE_CLIENT_INFO
Updates about the information of clients.
Definition: tcp_admin.h:76
ADMIN_PACKET_SERVER_COMPANY_INFO
@ ADMIN_PACKET_SERVER_COMPANY_INFO
The server gives the admin information about a company.
Definition: tcp_admin.h:49
NetworkClientInfo::client_playas
CompanyID client_playas
As which company is this client playing (CompanyID)
Definition: network_base.h:28
ServerNetworkAdminSocketHandler::SendCompanyEconomy
NetworkRecvStatus SendCompanyEconomy()
Send economic information of all companies.
Definition: network_admin.cpp:400
CompanyProperties::inaugurated_year
Year inaugurated_year
Year of starting the company.
Definition: company_base.h:79
ServerNetworkAdminSocketHandler::update_frequency
AdminUpdateFrequency update_frequency[ADMIN_UPDATE_END]
Admin requested update intervals.
Definition: network_admin.h:39
ADMIN_UPDATE_CONSOLE
@ ADMIN_UPDATE_CONSOLE
The admin would like to have console messages.
Definition: tcp_admin.h:81
ADMIN_PACKET_SERVER_PONG
@ ADMIN_PACKET_SERVER_PONG
The server replies to a ping request from the admin.
Definition: tcp_admin.h:61
GetCommandName
const char * GetCommandName(uint32 cmd)
Definition: command.cpp:407
NetworkAction
NetworkAction
Actions that can be used for NetworkTextMessage.
Definition: network_type.h:91
ADMIN_UPDATE_CHAT
@ ADMIN_UPDATE_CHAT
The admin would like to have chat messages.
Definition: tcp_admin.h:80
NetworkClientInfo::client_name
char client_name[NETWORK_CLIENT_NAME_LENGTH]
Name of the client.
Definition: network_base.h:26
CommandPacket::frame
uint32 frame
the frame in which this packet is executed
Definition: network_internal.h:147
NetworkAdminChat
void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data, bool from_admin)
Send chat to the admin network (if they did opt in for the respective update).
Definition: network_admin.cpp:922
Pool::PoolItem<&_networkadminsocket_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:227
NetworkPopulateCompanyStats
void NetworkPopulateCompanyStats(NetworkCompanyStats *stats)
Populate the company stats.
Definition: network_server.cpp:1587
ServerNetworkAdminSocketHandler::WelcomeAll
static void WelcomeAll()
Send a Welcome packet to all connected admins.
Definition: network_admin.cpp:990
NETWORK_CHAT_LENGTH
static const uint NETWORK_CHAT_LENGTH
The maximum length of a chat message, in bytes including '\0'.
Definition: config.h:50
ServerNetworkAdminSocketHandler::Receive_ADMIN_JOIN
NetworkRecvStatus Receive_ADMIN_JOIN(Packet *p) override
Join the admin network: string Password the server is expecting for this network.
Definition: network_admin.cpp:663
ADMIN_PACKET_SERVER_NEWGAME
@ ADMIN_PACKET_SERVER_NEWGAME
The server tells the admin its going to start a new game.
Definition: tcp_admin.h:39
NetworkServerGameInfo::map_name
char map_name[NETWORK_NAME_LENGTH]
Map which is played ["random" for a randomized map].
Definition: game_info.h:64
NetworkClientInfo::join_date
Date join_date
Gamedate the client has joined.
Definition: network_base.h:29
ADMIN_FREQUENCY_DAILY
@ ADMIN_FREQUENCY_DAILY
The admin gets information about this on a daily basis.
Definition: tcp_admin.h:91
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
CommandContainer::p2
uint32 p2
parameter p2.
Definition: command_type.h:482
ServerNetworkAdminSocketHandler::IterateActive
static Pool::IterateWrapperFiltered< ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter > IterateActive(size_t from=0)
Returns an iterable ensemble of all active admin sockets.
Definition: network_admin.h:95
ADMIN_PACKET_SERVER_CHAT
@ ADMIN_PACKET_SERVER_CHAT
The server received a chat message and relays it.
Definition: tcp_admin.h:54
ADMIN_PACKET_SERVER_COMPANY_NEW
@ ADMIN_PACKET_SERVER_COMPANY_NEW
The server tells the admin that a new company has started.
Definition: tcp_admin.h:48
ServerNetworkAdminSocketHandler::SendCompanyUpdate
NetworkRecvStatus SendCompanyUpdate(const Company *c)
Send an update about a company.
Definition: network_admin.cpp:353
ADMIN_PACKET_SERVER_PROTOCOL
@ ADMIN_PACKET_SERVER_PROTOCOL
The server tells the admin its protocol version.
Definition: tcp_admin.h:37
ADMIN_UPDATE_CMD_LOGGING
@ ADMIN_UPDATE_CMD_LOGGING
The admin would like to have DoCommand information.
Definition: tcp_admin.h:83
CommandContainer::text
char text[32 *MAX_CHAR_LENGTH]
possible text sent for name changes etc, in bytes including '\0'.
Definition: command_type.h:485
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:79
ADMIN_FREQUENCY_MONTHLY
@ ADMIN_FREQUENCY_MONTHLY
The admin gets information about this on a monthly basis.
Definition: tcp_admin.h:93
GetNetworkErrorMsg
StringID GetNetworkErrorMsg(NetworkErrorCode err)
Retrieve the string id of an internal error number.
Definition: network.cpp:294
ADMIN_PACKET_SERVER_COMPANY_STATS
@ ADMIN_PACKET_SERVER_COMPANY_STATS
The server gives the admin some statistics about a company.
Definition: tcp_admin.h:53
NetworkAdminGameScript
void NetworkAdminGameScript(const char *json)
Send GameScript JSON to the admin network (if they did opt in for the respective update).
Definition: network_admin.cpp:962
_network_game_info
NetworkServerGameInfo _network_game_info
Information about our game.
Definition: game_info.cpp:35
NetworkSettings::admin_password
char admin_password[NETWORK_PASSWORD_LENGTH]
password for the admin network
Definition: settings_type.h:268
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
NETWORK_GAME_ADMIN_VERSION
static const byte NETWORK_GAME_ADMIN_VERSION
What version of the admin network do we use?
Definition: config.h:35
Packet::Send_uint8
void Send_uint8(uint8 data)
Package a 8 bits integer in the packet.
Definition: packet.cpp:96
ServerNetworkAdminSocketHandler::SendCompanyInfo
NetworkRecvStatus SendCompanyInfo(const Company *c)
Send the admin some information about a company.
Definition: network_admin.cpp:317
ServerNetworkAdminSocketHandler::address
NetworkAddress address
Address of the admin.
Definition: network_admin.h:41
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:199
INVALID_ADMIN_ID
static const AdminIndex INVALID_ADMIN_ID
An invalid admin marker.
Definition: network_type.h:54
NetworkAdminClientQuit
void NetworkAdminClientQuit(ClientID client_id)
Notify the admin network that a client quit (if they have opt in for the respective update).
Definition: network_admin.cpp:846
NetworkAdminConsole
void NetworkAdminConsole(const char *origin, const char *string)
Send console to the admin network (if they did opt in for the respective update).
Definition: network_admin.cpp:949
_redirect_console_to_admin
AdminIndex _redirect_console_to_admin
Redirection of the (remote) console to the admin.
Definition: network_admin.cpp:31
_networkadminsocket_pool
NetworkAdminSocketPool _networkadminsocket_pool("NetworkAdminSocket")
The pool with sockets/clients.
ServerNetworkAdminSocketHandler::Send
static void Send()
Send the packets for the server sockets.
Definition: network_admin.cpp:96
network_base.h
NetworkAdminClientInfo
void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client)
Notify the admin network of a new client (if they did opt in for the respective update).
Definition: network_admin.cpp:817
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:564
Packet::Send_uint32
void Send_uint32(uint32 data)
Package a 32 bits integer in the packet.
Definition: packet.cpp:117
MapSizeX
static uint MapSizeX()
Get the size of the map along the X.
Definition: map_func.h:72
Pool::MAX_SIZE
static constexpr size_t MAX_SIZE
Make template parameter accessible from outside.
Definition: pool_type.hpp:85
NetworkClientInfo::GetByClientID
static NetworkClientInfo * GetByClientID(ClientID client_id)
Return the CI given it's client-identifier.
Definition: network.cpp:111
ADMIN_FREQUENCY_QUARTERLY
@ ADMIN_FREQUENCY_QUARTERLY
The admin gets information about this on a quarterly basis.
Definition: tcp_admin.h:94
CommandPacket::company
CompanyID company
company that is executing the command
Definition: network_internal.h:146
NetworkClientInfo::client_lang
byte client_lang
The language of the client.
Definition: network_base.h:27
ADMIN_STATUS_INACTIVE
@ ADMIN_STATUS_INACTIVE
The admin is not connected nor active.
Definition: tcp_admin.h:68
ADMIN_PACKET_SERVER_DATE
@ ADMIN_PACKET_SERVER_DATE
The server tells the admin what the current game date is.
Definition: tcp_admin.h:42
ADMIN_PACKET_SERVER_ERROR
@ ADMIN_PACKET_SERVER_ERROR
The server tells the admin an error has occurred.
Definition: tcp_admin.h:36
CommandContainer::p1
uint32 p1
parameter p1.
Definition: command_type.h:481
ServerNetworkAdminSocketHandler::SendShutdown
NetworkRecvStatus SendShutdown()
Tell the admin we're shutting down.
Definition: network_admin.cpp:195
NetworkCompanyStats::num_vehicle
uint16 num_vehicle[NETWORK_VEH_END]
How many vehicles are there of this type?
Definition: network_type.h:58
Packet::Recv_uint32
uint32 Recv_uint32()
Read a 32 bits integer from the packet.
Definition: packet.cpp:246
CompanyProperties::colour
byte colour
Company colour.
Definition: company_base.h:70
NetworkAdminSocketHandler::admin_version
char admin_version[NETWORK_REVISION_LENGTH]
Version string of the admin.
Definition: tcp_admin.h:113
ServerNetworkAdminSocketHandler::connect_time
std::chrono::steady_clock::time_point connect_time
Time of connection.
Definition: network_admin.h:40
CommandPacket
Everything we need to know about a command to be able to execute it.
Definition: network_internal.h:142
_date
Date _date
Current date in days (day counter)
Definition: date.cpp:28
MAX_ADMINS
static const AdminIndex MAX_ADMINS
Maximum number of allowed admins.
Definition: network_type.h:52
DEBUG
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
Packet::Send_string
void Send_string(const char *data)
Sends a string over the network.
Definition: packet.cpp:148
NetworkAddress::GetHostname
const char * GetHostname()
Get the hostname; in case it wasn't given the IPv4 dotted representation is given.
Definition: address.cpp:22
CompanyProperties::months_of_bankruptcy
byte months_of_bankruptcy
Number of months that the company is unable to pay its debts.
Definition: company_base.h:81
ServerNetworkAdminSocketHandler::SendCompanyRemove
NetworkRecvStatus SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
Tell the admin that a company got removed.
Definition: network_admin.cpp:387
ConvertYMDToDate
Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
Definition: date.cpp:149
ClientID
ClientID
'Unique' identifier to be given to clients
Definition: network_type.h:39
Packet::size
PacketSize size
The size of the whole packet for received packets.
Definition: packet.h:48
NetworkAdminSocketHandler
Main socket handler for admin related connections.
Definition: tcp_admin.h:110
ADMIN_PACKET_SERVER_COMPANY_REMOVE
@ ADMIN_PACKET_SERVER_COMPANY_REMOVE
The server tells the admin that a company was removed.
Definition: tcp_admin.h:51
SEND_MTU
static const uint16 SEND_MTU
Number of bytes we can pack in a single packet.
Definition: config.h:33
ADMIN_FREQUENCY_POLL
@ ADMIN_FREQUENCY_POLL
The admin can poll this.
Definition: tcp_admin.h:90
ADMIN_PACKET_SERVER_CLIENT_ERROR
@ ADMIN_PACKET_SERVER_CLIENT_ERROR
The server tells the admin that a client caused an error.
Definition: tcp_admin.h:47
ADMIN_UPDATE_DATE
@ ADMIN_UPDATE_DATE
Updates about the date of the game.
Definition: tcp_admin.h:75
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:80
ServerNetworkAdminSocketHandler::AllowConnection
static bool AllowConnection()
Whether a connection is allowed or not at this moment.
Definition: network_admin.cpp:85
ServerNetworkAdminSocketHandler::SendWelcome
NetworkRecvStatus SendWelcome()
Send a welcome message to the admin.
Definition: network_admin.cpp:166
Game::NewEvent
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:141
MAX_COMPANIES
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
ServerNetworkAdminSocketHandler::SendRcon
NetworkRecvStatus SendRcon(uint16 colour, const char *command)
Send the reply of an rcon command.
Definition: network_admin.cpp:502
ADMIN_UPDATE_COMPANY_STATS
@ ADMIN_UPDATE_COMPANY_STATS
Updates about the statistics of companies.
Definition: tcp_admin.h:79
ADMIN_UPDATE_COMPANY_ECONOMY
@ ADMIN_UPDATE_COMPANY_ECONOMY
Updates about the economy of companies.
Definition: tcp_admin.h:78
Packet::Send_uint16
void Send_uint16(uint16 data)
Package a 16 bits integer in the packet.
Definition: packet.cpp:106
NetworkTCPSocketHandler::SendPacket
virtual void SendPacket(Packet *packet)
This function puts the packet in the send-queue and it is send as soon as possible.
Definition: tcp.cpp:61
CLIENT_ID_SERVER
@ CLIENT_ID_SERVER
Servers always have this ID.
Definition: network_type.h:41
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:60
ServerNetworkAdminSocketHandler::~ServerNetworkAdminSocketHandler
~ServerNetworkAdminSocketHandler()
Clear everything related to this admin.
Definition: network_admin.cpp:74
ADMIN_PACKET_SERVER_RCON
@ ADMIN_PACKET_SERVER_RCON
The server's reply to a remove console command.
Definition: tcp_admin.h:55
ServerNetworkAdminSocketHandler::SendClientQuit
NetworkRecvStatus SendClientQuit(ClientID client_id)
Tell the admin that a client quit.
Definition: network_admin.cpp:273
AdminCompanyRemoveReason
AdminCompanyRemoveReason
Reasons for removing a company - communicated to admins.
Definition: tcp_admin.h:101
ADMIN_PACKET_SERVER_CONSOLE
@ ADMIN_PACKET_SERVER_CONSOLE
The server gives the admin the data that got printed to its console.
Definition: tcp_admin.h:56
ADMIN_PACKET_SERVER_CLIENT_UPDATE
@ ADMIN_PACKET_SERVER_CLIENT_UPDATE
The server gives the admin an information update on a client.
Definition: tcp_admin.h:45
MapSizeY
static uint MapSizeY()
Get the size of the map along the Y.
Definition: map_func.h:82
NetworkSettings::server_name
char server_name[NETWORK_NAME_LENGTH]
name of the server
Definition: settings_type.h:265
CompanyProperties::share_owners
Owner share_owners[4]
Owners of the 4 shares of the company. INVALID_OWNER if nobody has bought them yet.
Definition: company_base.h:77
network_server.h
_network_dedicated
bool _network_dedicated
are we a dedicated server?
Definition: network.cpp:55
ADMIN_UPDATE_GAMESCRIPT
@ ADMIN_UPDATE_GAMESCRIPT
The admin would like to have gamescript messages.
Definition: tcp_admin.h:84
Packet
Internal entity of a packet.
Definition: packet.h:40
ADMIN_FREQUENCY_ANUALLY
@ ADMIN_FREQUENCY_ANUALLY
The admin gets information about this on a yearly basis.
Definition: tcp_admin.h:95
ServerNetworkAdminSocketHandler::SendCmdNames
NetworkRecvStatus SendCmdNames()
Send the names of the commands.
Definition: network_admin.cpp:607
NetworkAdminCompanyRemove
void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
Notify the admin network of a company to be removed (including the reason why).
Definition: network_admin.cpp:911
NetworkCompanyIsPassworded
bool NetworkCompanyIsPassworded(CompanyID company_id)
Check if the company we want to join requires a password.
Definition: network.cpp:208
AdminUpdateType
AdminUpdateType
Update types an admin can register a frequency for.
Definition: tcp_admin.h:74
NetworkClientInfo::client_id
ClientID client_id
Client identifier (same as ClientState->client_id)
Definition: network_base.h:25
ADMIN_PACKET_SERVER_RCON_END
@ ADMIN_PACKET_SERVER_RCON_END
The server indicates that the remote console command has completed.
Definition: tcp_admin.h:60
NETWORK_PASSWORD_LENGTH
static const uint NETWORK_PASSWORD_LENGTH
The maximum length of the password, in bytes including '\0' (must be >= NETWORK_SERVER_ID_LENGTH)
Definition: config.h:45
ServerNetworkAdminSocketHandler::SendNewGame
NetworkRecvStatus SendNewGame()
Tell the admin we started a new game.
Definition: network_admin.cpp:187
Packet::Send_bool
void Send_bool(bool data)
Package a boolean in the packet.
Definition: packet.cpp:87
_network_own_client_id
ClientID _network_own_client_id
Our client identifier.
Definition: network.cpp:58
NetworkAdminCompanyUpdate
void NetworkAdminCompanyUpdate(const Company *company)
Notify the admin network of company updates.
Definition: network_admin.cpp:895
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
ADMIN_PACKET_SERVER_CLIENT_JOIN
@ ADMIN_PACKET_SERVER_CLIENT_JOIN
The server tells the admin that a client has joined.
Definition: tcp_admin.h:43
NetworkAddress
Wrapper for (un)resolved network addresses; there's no reason to transform a numeric IP to a string a...
Definition: address.h:29
NETWORK_RCONCOMMAND_LENGTH
static const uint NETWORK_RCONCOMMAND_LENGTH
The maximum length of a rconsole command, in bytes including '\0'.
Definition: config.h:48
Pool::PoolItem<&_networkadminsocket_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:378
ServerNetworkAdminSocketHandler::SendDate
NetworkRecvStatus SendDate()
Tell the admin the date.
Definition: network_admin.cpp:203
ServerNetworkAdminSocketHandler::SendCompanyNew
NetworkRecvStatus SendCompanyNew(CompanyID company_id)
Tell the admin that a new company was founded.
Definition: network_admin.cpp:303
Pool
Base class for all pools.
Definition: pool_type.hpp:81
ADMIN_PACKET_SERVER_CMD_NAMES
@ ADMIN_PACKET_SERVER_CMD_NAMES
The server sends out the names of the DoCommands to the admins.
Definition: tcp_admin.h:57
ServerNetworkAdminSocketHandler::Receive_ADMIN_QUIT
NetworkRecvStatus Receive_ADMIN_QUIT(Packet *p) override
Notification to the server that this admin is quitting.
Definition: network_admin.cpp:691
ADMIN_PACKET_SERVER_CLIENT_INFO
@ ADMIN_PACKET_SERVER_CLIENT_INFO
The server gives the admin information about a client.
Definition: tcp_admin.h:44
CMD_ID_MASK
@ CMD_ID_MASK
mask for the command ID
Definition: command_type.h:382
ServerNetworkAdminSocketHandler::SendPong
NetworkRecvStatus SendPong(uint32 d1)
Send ping-reply (pong) to admin.
Definition: network_admin.cpp:596
Packet::Send_uint64
void Send_uint64(uint64 data)
Package a 64 bits integer in the packet.
Definition: packet.cpp:130
ServerNetworkAdminSocketHandler::ServerNetworkAdminSocketHandler
ServerNetworkAdminSocketHandler(SOCKET s)
Sanity check.
Definition: network_admin.cpp:64
ServerNetworkAdminSocketHandler
Class for handling the server side of the game connection.
Definition: network_admin.h:25
NetworkRecvStatus
NetworkRecvStatus
Status of a network client; reasons why a client has quit.
Definition: core.h:22
ServerNetworkAdminSocketHandler::Receive_ADMIN_POLL
NetworkRecvStatus Receive_ADMIN_POLL(Packet *p) override
Poll the server for certain updates, an invalid poll (e.g.
Definition: network_admin.cpp:715
ServerNetworkAdminSocketHandler::SendClientInfo
NetworkRecvStatus SendClientInfo(const NetworkClientSocket *cs, const NetworkClientInfo *ci)
Send an initial set of data from some client's information.
Definition: network_admin.cpp:232
NetworkServerSendChat
void NetworkServerSendChat(NetworkAction action, DestType type, int dest, const char *msg, ClientID from_id, int64 data=0, bool from_admin=false)
Send an actual chat message.
Definition: network_server.cpp:1295
ADMIN_FREQUENCY_AUTOMATIC
@ ADMIN_FREQUENCY_AUTOMATIC
The admin gets information about this when it changes.
Definition: tcp_admin.h:96
ADMIN_STATUS_ACTIVE
@ ADMIN_STATUS_ACTIVE
The admin is active.
Definition: tcp_admin.h:69
ADMIN_PACKET_SERVER_COMPANY_UPDATE
@ ADMIN_PACKET_SERVER_COMPANY_UPDATE
The server gives the admin an information update on a company.
Definition: tcp_admin.h:50
ServerNetworkAdminSocketHandler::SendProtocol
NetworkRecvStatus SendProtocol()
Send the protocol version to the admin.
Definition: network_admin.cpp:146
ServerNetworkAdminSocketHandler::SendRconEnd
NetworkRecvStatus SendRconEnd(const char *command)
Send a notification indicating the rcon command has completed.
Definition: network_admin.cpp:487
ServerNetworkAdminSocketHandler::Receive_ADMIN_PING
NetworkRecvStatus Receive_ADMIN_PING(Packet *p) override
Ping the server, requiring the server to reply with a pong packet.
Definition: network_admin.cpp:543
Pool::PoolItem<&_networkadminsocket_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:299
ADMIN_PACKET_SERVER_WELCOME
@ ADMIN_PACKET_SERVER_WELCOME
The server welcomes the admin to a game.
Definition: tcp_admin.h:38
NetworkAdminSocketHandler::admin_name
char admin_name[NETWORK_CLIENT_NAME_LENGTH]
Name of the admin.
Definition: tcp_admin.h:112
game_info.h
GameCreationSettings::starting_year
Year starting_year
starting date
Definition: settings_type.h:293
Packet::Recv_uint8
uint8 Recv_uint8()
Read a 8 bits integer from the packet.
Definition: packet.cpp:217
GetNetworkRevisionString
const char * GetNetworkRevisionString()
Get the network version string used by this build.
Definition: game_info.cpp:41
ServerNetworkAdminSocketHandler::AcceptConnection
static void AcceptConnection(SOCKET s, const NetworkAddress &address)
Handle the acception of a connection.
Definition: network_admin.cpp:115
ServerNetworkAdminSocketHandler::SendClientUpdate
NetworkRecvStatus SendClientUpdate(const NetworkClientInfo *ci)
Send an update for some client's information.
Definition: network_admin.cpp:256
INSTANTIATE_POOL_METHODS
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Definition: pool_func.hpp:224
ADMIN_PACKET_SERVER_COMPANY_ECONOMY
@ ADMIN_PACKET_SERVER_COMPANY_ECONOMY
The server gives the admin some economy related company information.
Definition: tcp_admin.h:52
error
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Definition: openttd.cpp:132
ADMIN_PACKET_SERVER_CMD_LOGGING
@ ADMIN_PACKET_SERVER_CMD_LOGGING
The server gives the admin copies of incoming command packets.
Definition: tcp_admin.h:58
AdminIndex
uint8 AdminIndex
Indices into the admin tables.
Definition: network_type.h:49
NetworkAdminClientUpdate
void NetworkAdminClientUpdate(const NetworkClientInfo *ci)
Notify the admin network of a client update (if they did opt in for the respective update).
Definition: network_admin.cpp:833
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:369
ClientSettings::network
NetworkSettings network
settings related to the network
Definition: settings_type.h:582
OverflowSafeInt< int64, INT64_MAX, INT64_MIN >
_network_admins_connected
byte _network_admins_connected
The amount of admins connected.
Definition: network_admin.cpp:34
IConsoleCmdExec
void IConsoleCmdExec(const char *cmdstr, const uint recurse_count)
Execute a given command passed to us.
Definition: console.cpp:407
NETWORK_RECV_STATUS_OKAY
@ NETWORK_RECV_STATUS_OKAY
Everything is okay.
Definition: core.h:23
CeilDiv
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:254
ADMIN_FREQUENCY_WEEKLY
@ ADMIN_FREQUENCY_WEEKLY
The admin gets information about this on a weekly basis.
Definition: tcp_admin.h:92
ServerNetworkAdminSocketHandler::Receive_ADMIN_RCON
NetworkRecvStatus Receive_ADMIN_RCON(Packet *p) override
Execute a command on the servers console: string Command to be executed.
Definition: network_admin.cpp:513
_admin_update_type_frequencies
static const AdminUpdateFrequency _admin_update_type_frequencies[]
Frequencies, which may be registered for a certain update type.
Definition: network_admin.cpp:45
CMD_END
@ CMD_END
Must ALWAYS be on the end of this list!! (period)
Definition: command_type.h:338
ServerNetworkAdminSocketHandler::Receive_ADMIN_CHAT
NetworkRecvStatus Receive_ADMIN_CHAT(Packet *p) override
Send chat as the server: uint8 Action such as NETWORK_ACTION_CHAT_CLIENT (see NetworkAction).
Definition: network_admin.cpp:781
NetworkAdminCmdLogging
void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp)
Distribute CommandPacket details over the admin network for logging purposes.
Definition: network_admin.cpp:976
ServerNetworkAdminSocketHandler::Receive_ADMIN_GAMESCRIPT
NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet *p) override
Send a JSON string to the current active GameScript.
Definition: network_admin.cpp:529
network_admin.h
CommandContainer::tile
TileIndex tile
tile command being executed on.
Definition: command_type.h:480
ServerNetworkAdminSocketHandler::SendCompanyStats
NetworkRecvStatus SendCompanyStats()
Send statistics about the companies.
Definition: network_admin.cpp:434
NETWORK_GAMESCRIPT_JSON_LENGTH
static const uint NETWORK_GAMESCRIPT_JSON_LENGTH
The maximum length of a gamescript json string, in bytes including '\0'. Must not be longer than SEND...
Definition: config.h:49
ADMIN_AUTHORISATION_TIMEOUT
static const std::chrono::seconds ADMIN_AUTHORISATION_TIMEOUT(10)
The timeout for authorisation of the client.
ADMIN_UPDATE_END
@ ADMIN_UPDATE_END
Must ALWAYS be on the end of this list!! (period)
Definition: tcp_admin.h:85
Company
Definition: company_base.h:110
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:385
AdminUpdateFrequency
AdminUpdateFrequency
Update frequencies an admin can register.
Definition: tcp_admin.h:89
ServerNetworkAdminSocketHandler::SendClientJoin
NetworkRecvStatus SendClientJoin(ClientID client_id)
Tell the admin that a client joined.
Definition: network_admin.cpp:217
ServerNetworkAdminSocketHandler::SendChat
NetworkRecvStatus SendChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data)
Send a chat message.
Definition: network_admin.cpp:469
NetworkAdminCompanyInfo
void NetworkAdminCompanyInfo(const Company *company, bool new_company)
Notify the admin network of company details.
Definition: network_admin.cpp:874
NetworkErrorCode
NetworkErrorCode
The error codes we send around in the protocols.
Definition: network_type.h:110
NetworkClientInfo
Container for all information known about a client.
Definition: network_base.h:24
NetworkAdminClientError
void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code)
Notify the admin network of a client error (if they have opt in for the respective update).
Definition: network_admin.cpp:860
Packet::Recv_uint16
uint16 Recv_uint16()
Read a 16 bits integer from the packet.
Definition: packet.cpp:231
NetworkServerSendAdminRcon
void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const char *string)
Pass the rcon reply to the admin.
Definition: network_admin.cpp:939
ServerNetworkAdminSocketHandler::SendClientError
NetworkRecvStatus SendClientError(ClientID client_id, NetworkErrorCode error)
Tell the admin that a client made an error.
Definition: network_admin.cpp:288
ADMIN_PACKET_SERVER_SHUTDOWN
@ ADMIN_PACKET_SERVER_SHUTDOWN
The server tells the admin its shutting down.
Definition: tcp_admin.h:40
NETWORK_COMPANY_NAME_LENGTH
static const uint NETWORK_COMPANY_NAME_LENGTH
The maximum length of the company name, in bytes including '\0'.
Definition: config.h:41
ServerNetworkAdminSocketHandler::SendCmdLogging
NetworkRecvStatus SendCmdLogging(ClientID client_id, const CommandPacket *cp)
Send a command for logging purposes.
Definition: network_admin.cpp:641