network_admin.cpp

Go to the documentation of this file.
00001 /* $Id: network_admin.cpp 21741 2011-01-08 16:10:07Z planetmaker $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #ifdef ENABLE_NETWORK
00013 
00014 #include "../stdafx.h"
00015 #include "../debug.h"
00016 #include "../strings_func.h"
00017 #include "../date_func.h"
00018 #include "network_admin.h"
00019 #include "network.h"
00020 #include "network_base.h"
00021 #include "network_server.h"
00022 #include "../command_func.h"
00023 #include "../company_base.h"
00024 #include "../console_func.h"
00025 #include "../core/pool_func.hpp"
00026 #include "../map_func.h"
00027 #include "../rev.h"
00028 
00029 #include "table/strings.h"
00030 #include "network_client.h"
00031 
00032 /* This file handles all the admin network commands. */
00033 
00035 AdminIndex _redirect_console_to_admin = INVALID_ADMIN_ID;
00036 
00038 byte _network_admins_connected = 0;
00039 
00040 NetworkAdminSocketPool _networkadminsocket_pool("NetworkAdminSocket");
00041 INSTANTIATE_POOL_METHODS(NetworkAdminSocket)
00042 
00043 
00044 static const int ADMIN_AUTHORISATION_TIMEOUT = 10000;
00045 
00046 
00048 static const AdminUpdateFrequency _admin_update_type_frequencies[] = {
00049   ADMIN_FREQUENCY_POLL | ADMIN_FREQUENCY_DAILY | ADMIN_FREQUENCY_WEEKLY | ADMIN_FREQUENCY_MONTHLY | ADMIN_FREQUENCY_QUARTERLY | ADMIN_FREQUENCY_ANUALLY, 
00050   ADMIN_FREQUENCY_POLL | ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
00051   ADMIN_FREQUENCY_POLL | ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
00052   ADMIN_FREQUENCY_POLL |                         ADMIN_FREQUENCY_WEEKLY | ADMIN_FREQUENCY_MONTHLY | ADMIN_FREQUENCY_QUARTERLY | ADMIN_FREQUENCY_ANUALLY, 
00053   ADMIN_FREQUENCY_POLL |                         ADMIN_FREQUENCY_WEEKLY | ADMIN_FREQUENCY_MONTHLY | ADMIN_FREQUENCY_QUARTERLY | ADMIN_FREQUENCY_ANUALLY, 
00054                          ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
00055                          ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
00056   ADMIN_FREQUENCY_POLL,                                                                                                                                  
00057                          ADMIN_FREQUENCY_AUTOMATIC,                                                                                                      
00058 };
00059 assert_compile(lengthof(_admin_update_type_frequencies) == ADMIN_UPDATE_END);
00060 
00065 ServerNetworkAdminSocketHandler::ServerNetworkAdminSocketHandler(SOCKET s) : NetworkAdminSocketHandler(s)
00066 {
00067   _network_admins_connected++;
00068   this->status = ADMIN_STATUS_INACTIVE;
00069   this->realtime_connect = _realtime_tick;
00070 }
00071 
00075 ServerNetworkAdminSocketHandler::~ServerNetworkAdminSocketHandler()
00076 {
00077   _network_admins_connected--;
00078   DEBUG(net, 1, "[admin] '%s' (%s) has disconnected", this->admin_name, this->admin_version);
00079   if (_redirect_console_to_admin == this->index) _redirect_console_to_admin = INVALID_ADMIN_ID;
00080 }
00081 
00086 /* static */ bool ServerNetworkAdminSocketHandler::AllowConnection()
00087 {
00088   return !StrEmpty(_settings_client.network.admin_password) && _network_admins_connected < MAX_ADMINS;
00089 }
00090 
00092 /* static */ void ServerNetworkAdminSocketHandler::Send()
00093 {
00094   ServerNetworkAdminSocketHandler *as;
00095   FOR_ALL_ADMIN_SOCKETS(as) {
00096     if (as->status == ADMIN_STATUS_INACTIVE && as->realtime_connect + ADMIN_AUTHORISATION_TIMEOUT < _realtime_tick) {
00097       DEBUG(net, 1, "[admin] Admin did not send its authorisation within %d seconds", ADMIN_AUTHORISATION_TIMEOUT / 1000);
00098       as->CloseConnection(true);
00099       continue;
00100     }
00101     if (as->writable) {
00102       as->SendPackets();
00103     }
00104   }
00105 }
00106 
00107 /* static */ void ServerNetworkAdminSocketHandler::AcceptConnection(SOCKET s, const NetworkAddress &address)
00108 {
00109   ServerNetworkAdminSocketHandler *as = new ServerNetworkAdminSocketHandler(s);
00110   as->address = address; // Save the IP of the client
00111 }
00112 
00113 /***********
00114  * Sending functions for admin network
00115  ************/
00116 
00117 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendError(NetworkErrorCode error)
00118 {
00119   Packet *p = new Packet(ADMIN_PACKET_SERVER_ERROR);
00120 
00121   p->Send_uint8(error);
00122   this->SendPacket(p);
00123 
00124   char str[100];
00125   StringID strid = GetNetworkErrorMsg(error);
00126   GetString(str, strid, lastof(str));
00127 
00128   DEBUG(net, 1, "[admin] the admin '%s' (%s) made an error and has been disconnected. Reason: '%s'", this->admin_name, this->admin_version, str);
00129 
00130   return this->CloseConnection(true);
00131 }
00132 
00133 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendProtocol()
00134 {
00135   Packet *p = new Packet(ADMIN_PACKET_SERVER_PROTOCOL);
00136 
00137   /* announce the protocol version */
00138   p->Send_uint8(NETWORK_GAME_ADMIN_VERSION);
00139 
00140   for (int i = 0; i < ADMIN_UPDATE_END; i++) {
00141     p->Send_bool  (true);
00142     p->Send_uint16(i);
00143     p->Send_uint16(_admin_update_type_frequencies[i]);
00144   }
00145 
00146   p->Send_bool(false);
00147   this->SendPacket(p);
00148 
00149   return this->SendWelcome();
00150 }
00151 
00152 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendWelcome()
00153 {
00154   this->status = ADMIN_STATUS_ACTIVE;
00155 
00156   Packet *p = new Packet(ADMIN_PACKET_SERVER_WELCOME);
00157 
00158   p->Send_string(_settings_client.network.server_name);
00159   p->Send_string(_openttd_revision);
00160   p->Send_bool  (_network_dedicated);
00161 
00162   p->Send_string(_network_game_info.map_name);
00163   p->Send_uint32(_settings_game.game_creation.generation_seed);
00164   p->Send_uint8 (_settings_game.game_creation.landscape);
00165   p->Send_uint32(ConvertYMDToDate(_settings_game.game_creation.starting_year, 0, 1));
00166   p->Send_uint16(MapSizeX());
00167   p->Send_uint16(MapSizeY());
00168 
00169   this->SendPacket(p);
00170 
00171   return NETWORK_RECV_STATUS_OKAY;
00172 }
00173 
00174 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendNewGame()
00175 {
00176   Packet *p = new Packet(ADMIN_PACKET_SERVER_NEWGAME);
00177   this->SendPacket(p);
00178   return NETWORK_RECV_STATUS_OKAY;
00179 }
00180 
00181 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendShutdown()
00182 {
00183   Packet *p = new Packet(ADMIN_PACKET_SERVER_SHUTDOWN);
00184   this->SendPacket(p);
00185   return NETWORK_RECV_STATUS_OKAY;
00186 }
00187 
00188 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendDate()
00189 {
00190   Packet *p = new Packet(ADMIN_PACKET_SERVER_DATE);
00191 
00192   p->Send_uint32(_date);
00193   this->SendPacket(p);
00194 
00195   return NETWORK_RECV_STATUS_OKAY;
00196 }
00197 
00198 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientJoin(ClientID client_id)
00199 {
00200   Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_JOIN);
00201 
00202   p->Send_uint32(client_id);
00203   this->SendPacket(p);
00204 
00205   return NETWORK_RECV_STATUS_OKAY;
00206 }
00207 
00208 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientInfo(const NetworkClientInfo *ci)
00209 {
00210   Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_INFO);
00211 
00212   p->Send_uint32(ci->client_id);
00213   p->Send_string(const_cast<NetworkAddress &>(ci->client_address).GetHostname());
00214   p->Send_string(ci->client_name);
00215   p->Send_uint8 (ci->client_lang);
00216   p->Send_uint32(ci->join_date);
00217   p->Send_uint8 (ci->client_playas);
00218 
00219   this->SendPacket(p);
00220 
00221   return NETWORK_RECV_STATUS_OKAY;
00222 }
00223 
00224 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientUpdate(const NetworkClientInfo *ci)
00225 {
00226   Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_UPDATE);
00227 
00228   p->Send_uint32(ci->client_id);
00229   p->Send_string(ci->client_name);
00230   p->Send_uint8 (ci->client_playas);
00231 
00232   this->SendPacket(p);
00233 
00234   return NETWORK_RECV_STATUS_OKAY;
00235 }
00236 
00237 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientQuit(ClientID client_id)
00238 {
00239   Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_QUIT);
00240 
00241   p->Send_uint32(client_id);
00242   this->SendPacket(p);
00243 
00244   return NETWORK_RECV_STATUS_OKAY;
00245 }
00246 
00247 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientError(ClientID client_id, NetworkErrorCode error)
00248 {
00249   Packet *p = new Packet(ADMIN_PACKET_SERVER_CLIENT_ERROR);
00250 
00251   p->Send_uint32(client_id);
00252   p->Send_uint8 (error);
00253   this->SendPacket(p);
00254 
00255   return NETWORK_RECV_STATUS_OKAY;
00256 }
00257 
00258 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyNew(CompanyID company_id)
00259 {
00260   Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_NEW);
00261   p->Send_uint8(company_id);
00262 
00263   this->SendPacket(p);
00264 
00265   return NETWORK_RECV_STATUS_OKAY;
00266 }
00267 
00268 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyInfo(const Company *c)
00269 {
00270   char company_name[NETWORK_COMPANY_NAME_LENGTH];
00271   char manager_name[NETWORK_COMPANY_NAME_LENGTH];
00272 
00273   SetDParam(0, c->index);
00274   GetString(company_name, STR_COMPANY_NAME, lastof(company_name));
00275 
00276   SetDParam(0, c->index);
00277   GetString(manager_name, STR_PRESIDENT_NAME, lastof(manager_name));
00278 
00279   Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_INFO);
00280 
00281   p->Send_uint8 (c->index);
00282   p->Send_string(company_name);
00283   p->Send_string(manager_name);
00284   p->Send_uint8 (c->colour);
00285   p->Send_bool  (NetworkCompanyIsPassworded(c->index));
00286   p->Send_uint32(c->inaugurated_year);
00287   p->Send_bool  (c->is_ai);
00288 
00289   this->SendPacket(p);
00290 
00291   return NETWORK_RECV_STATUS_OKAY;
00292 }
00293 
00294 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyUpdate(const Company *c)
00295 {
00296   char company_name[NETWORK_COMPANY_NAME_LENGTH];
00297   char manager_name[NETWORK_COMPANY_NAME_LENGTH];
00298 
00299   SetDParam(0, c->index);
00300   GetString(company_name, STR_COMPANY_NAME, lastof(company_name));
00301 
00302   SetDParam(0, c->index);
00303   GetString(manager_name, STR_PRESIDENT_NAME, lastof(manager_name));
00304 
00305   Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_UPDATE);
00306 
00307   p->Send_uint8 (c->index);
00308   p->Send_string(company_name);
00309   p->Send_string(manager_name);
00310   p->Send_uint8 (c->colour);
00311   p->Send_bool  (NetworkCompanyIsPassworded(c->index));
00312   p->Send_uint8 (c->quarters_of_bankruptcy);
00313 
00314   for (size_t i = 0; i < lengthof(c->share_owners); i++) {
00315     p->Send_uint8(c->share_owners[i]);
00316   }
00317 
00318   this->SendPacket(p);
00319 
00320   return NETWORK_RECV_STATUS_OKAY;
00321 }
00322 
00323 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason acrr)
00324 {
00325   Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_REMOVE);
00326 
00327   p->Send_uint8(company_id);
00328   p->Send_uint8(acrr);
00329 
00330   this->SendPacket(p);
00331 
00332   return NETWORK_RECV_STATUS_OKAY;
00333 }
00334 
00335 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyEconomy()
00336 {
00337   const Company *company;
00338   FOR_ALL_COMPANIES(company) {
00339     /* Get the income. */
00340     Money income = 0;
00341     for (uint i = 0; i < lengthof(company->yearly_expenses[0]); i++) {
00342       income -= company->yearly_expenses[0][i];
00343     }
00344 
00345     Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_ECONOMY);
00346 
00347     p->Send_uint8(company->index);
00348 
00349     /* Current information. */
00350     p->Send_uint64(company->money);
00351     p->Send_uint64(company->current_loan);
00352     p->Send_uint64(income);
00353     p->Send_uint16(company->cur_economy.delivered_cargo);
00354 
00355     /* Send stats for the last 2 quarters. */
00356     for (uint i = 0; i < 2; i++) {
00357       p->Send_uint64(company->old_economy[i].company_value);
00358       p->Send_uint16(company->old_economy[i].performance_history);
00359       p->Send_uint16(company->old_economy[i].delivered_cargo);
00360     }
00361 
00362     this->SendPacket(p);
00363   }
00364 
00365 
00366   return NETWORK_RECV_STATUS_OKAY;
00367 }
00368 
00369 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyStats()
00370 {
00371   /* Fetch the latest version of the stats. */
00372   NetworkCompanyStats company_stats[MAX_COMPANIES];
00373   NetworkPopulateCompanyStats(company_stats);
00374 
00375   const Company *company;
00376 
00377   /* Go through all the companies. */
00378   FOR_ALL_COMPANIES(company) {
00379     Packet *p = new Packet(ADMIN_PACKET_SERVER_COMPANY_STATS);
00380 
00381     /* Send the information. */
00382     p->Send_uint8(company->index);
00383 
00384     for (uint i = 0; i < NETWORK_VEH_END; i++) {
00385       p->Send_uint16(company_stats[company->index].num_vehicle[i]);
00386     }
00387 
00388     for (uint i = 0; i < NETWORK_VEH_END; i++) {
00389       p->Send_uint16(company_stats[company->index].num_station[i]);
00390     }
00391 
00392     this->SendPacket(p);
00393   }
00394 
00395   return NETWORK_RECV_STATUS_OKAY;
00396 }
00397 
00398 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data)
00399 {
00400   Packet *p = new Packet(ADMIN_PACKET_SERVER_CHAT);
00401 
00402   p->Send_uint8 (action);
00403   p->Send_uint8 (desttype);
00404   p->Send_uint32(client_id);
00405   p->Send_string(msg);
00406   p->Send_uint64(data);
00407 
00408   this->SendPacket(p);
00409   return NETWORK_RECV_STATUS_OKAY;
00410 }
00411 
00412 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendRcon(uint16 colour, const char *result)
00413 {
00414   Packet *p = new Packet(ADMIN_PACKET_SERVER_RCON);
00415 
00416   p->Send_uint16(colour);
00417   p->Send_string(result);
00418   this->SendPacket(p);
00419 
00420   return NETWORK_RECV_STATUS_OKAY;
00421 }
00422 
00423 DEF_ADMIN_RECEIVE_COMMAND(Server, ADMIN_PACKET_ADMIN_RCON)
00424 {
00425   if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
00426 
00427   char command[NETWORK_RCONCOMMAND_LENGTH];
00428 
00429   p->Recv_string(command, sizeof(command));
00430 
00431   DEBUG(net, 2, "[admin] Rcon command from '%s' (%s): '%s'", this->admin_name, this->admin_version, command);
00432 
00433   _redirect_console_to_admin = this->index;
00434   IConsoleCmdExec(command);
00435   _redirect_console_to_admin = INVALID_ADMIN_ID;
00436   return NETWORK_RECV_STATUS_OKAY;
00437 }
00438 
00439 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendConsole(const char *origin, const char *string)
00440 {
00441   /* If the length of both strings, plus the 2 '\0' terminations and 3 bytes of the packet
00442    * are bigger than the MTU, just ignore the message. Better safe than sorry. It should
00443    * never occur though as the longest strings are chat messages, which are still 30%
00444    * smaller than SEND_MTU. */
00445   if (strlen(origin) + strlen(string) + 2 + 3 >= SEND_MTU) return NETWORK_RECV_STATUS_OKAY;
00446 
00447   Packet *p = new Packet(ADMIN_PACKET_SERVER_CONSOLE);
00448 
00449   p->Send_string(origin);
00450   p->Send_string(string);
00451   this->SendPacket(p);
00452 
00453   return NETWORK_RECV_STATUS_OKAY;
00454 }
00455 
00456 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCmdNames()
00457 {
00458   Packet *p = new Packet(ADMIN_PACKET_SERVER_CMD_NAMES);
00459 
00460   for (uint i = 0; i < CMD_END; i++) {
00461     const char *cmdname = GetCommandName(i);
00462 
00463     /* Should SEND_MTU be exceeded, start a new packet
00464      * (magic 5: 1 bool "more data" and one uint16 "command id", one
00465      * byte for string '\0' termination and 1 bool "no more data" */
00466     if (p->size + strlen(cmdname) + 5 >= SEND_MTU) {
00467       p->Send_bool(false);
00468       this->SendPacket(p);
00469 
00470       p = new Packet(ADMIN_PACKET_SERVER_CMD_NAMES);
00471     }
00472 
00473     p->Send_bool(true);
00474     p->Send_uint16(i);
00475     p->Send_string(cmdname);
00476   }
00477 
00478   /* Marker to notify the end of the packet has been reached. */
00479   p->Send_bool(false);
00480   this->SendPacket(p);
00481 
00482   return NETWORK_RECV_STATUS_OKAY;
00483 }
00484 
00485 NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCmdLogging(ClientID client_id, const CommandPacket *cp)
00486 {
00487   Packet *p = new Packet(ADMIN_PACKET_SERVER_CMD_LOGGING);
00488 
00489   p->Send_uint32(client_id);
00490   p->Send_uint8 (cp->company);
00491   p->Send_uint16(cp->cmd & CMD_ID_MASK);
00492   p->Send_uint32(cp->p1);
00493   p->Send_uint32(cp->p2);
00494   p->Send_uint32(cp->tile);
00495   p->Send_string(cp->text);
00496   p->Send_uint32(cp->frame);
00497 
00498   this->SendPacket(p);
00499 
00500   return NETWORK_RECV_STATUS_OKAY;
00501 }
00502 
00503 /***********
00504  * Receiving functions
00505  ************/
00506 
00507 DEF_ADMIN_RECEIVE_COMMAND(Server, ADMIN_PACKET_ADMIN_JOIN)
00508 {
00509   if (this->status != ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
00510 
00511   char password[NETWORK_PASSWORD_LENGTH];
00512   p->Recv_string(password, sizeof(password));
00513 
00514   if (StrEmpty(_settings_client.network.admin_password) ||
00515       strcmp(password, _settings_client.network.admin_password) != 0) {
00516     /* Password is invalid */
00517     return this->SendError(NETWORK_ERROR_WRONG_PASSWORD);
00518   }
00519 
00520   p->Recv_string(this->admin_name, sizeof(this->admin_name));
00521   p->Recv_string(this->admin_version, sizeof(this->admin_version));
00522 
00523   if (StrEmpty(this->admin_name) || StrEmpty(this->admin_version)) {
00524     /* no name or version supplied */
00525     return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
00526   }
00527 
00528   DEBUG(net, 1, "[admin] '%s' (%s) has connected", this->admin_name, this->admin_version);
00529 
00530   return this->SendProtocol();
00531 }
00532 
00533 DEF_ADMIN_RECEIVE_COMMAND(Server, ADMIN_PACKET_ADMIN_QUIT)
00534 {
00535   /* The admin is leaving nothing else to do */
00536   return this->CloseConnection();
00537 }
00538 
00539 DEF_ADMIN_RECEIVE_COMMAND(Server, ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY)
00540 {
00541   if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
00542 
00543   AdminUpdateType type = (AdminUpdateType)p->Recv_uint16();
00544   AdminUpdateFrequency freq = (AdminUpdateFrequency)p->Recv_uint16();
00545 
00546   if (type >= ADMIN_UPDATE_END || (_admin_update_type_frequencies[type] & freq) != freq) {
00547     /* The server does not know of this UpdateType. */
00548     DEBUG(net, 3, "[admin] Not supported update frequency %d (%d) from '%s' (%s).", type, freq, this->admin_name, this->admin_version);
00549     return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
00550   }
00551 
00552   this->update_frequency[type] = freq;
00553 
00554   return NETWORK_RECV_STATUS_OKAY;
00555 }
00556 
00557 DEF_ADMIN_RECEIVE_COMMAND(Server, ADMIN_PACKET_ADMIN_POLL)
00558 {
00559   if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
00560 
00561   AdminUpdateType type = (AdminUpdateType)p->Recv_uint8();
00562   uint32 d1 = p->Recv_uint32();
00563 
00564   switch (type) {
00565     case ADMIN_UPDATE_DATE:
00566       /* The admin is requesting the current date. */
00567       this->SendDate();
00568       break;
00569 
00570     case ADMIN_UPDATE_CLIENT_INFO:
00571       /* The admin is requesting client info. */
00572       const NetworkClientInfo *ci;
00573       if (d1 == UINT32_MAX) {
00574         FOR_ALL_CLIENT_INFOS(ci) {
00575           this->SendClientInfo(ci);
00576         }
00577       } else {
00578         ci = NetworkFindClientInfoFromClientID((ClientID)d1);
00579         if (ci != NULL) this->SendClientInfo(ci);
00580       }
00581       break;
00582 
00583     case ADMIN_UPDATE_COMPANY_INFO:
00584       /* The admin is asking for company info. */
00585       const Company *company;
00586       if (d1 == UINT32_MAX) {
00587         FOR_ALL_COMPANIES(company) {
00588           this->SendCompanyInfo(company);
00589         }
00590       } else {
00591         company = Company::GetIfValid(d1);
00592         if (company != NULL) this->SendCompanyInfo(company);
00593       }
00594       break;
00595 
00596     case ADMIN_UPDATE_COMPANY_ECONOMY:
00597       /* The admin is requesting economy info. */
00598       this->SendCompanyEconomy();
00599       break;
00600 
00601     case ADMIN_UPDATE_COMPANY_STATS:
00602       /* the admin is requesting company stats. */
00603       this->SendCompanyStats();
00604       break;
00605 
00606     case ADMIN_UPDATE_CMD_NAMES:
00607       /* The admin is requesting the names of DoCommands. */
00608       this->SendCmdNames();
00609       break;
00610 
00611     default:
00612       /* An unsupported "poll" update type. */
00613       DEBUG(net, 3, "[admin] Not supported poll %d (%d) from '%s' (%s).", type, d1, this->admin_name, this->admin_version);
00614       return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
00615   }
00616 
00617   return NETWORK_RECV_STATUS_OKAY;
00618 }
00619 
00620 DEF_ADMIN_RECEIVE_COMMAND(Server, ADMIN_PACKET_ADMIN_CHAT)
00621 {
00622   if (this->status == ADMIN_STATUS_INACTIVE) return this->SendError(NETWORK_ERROR_NOT_EXPECTED);
00623 
00624   NetworkAction action = (NetworkAction)p->Recv_uint8();
00625   DestType desttype = (DestType)p->Recv_uint8();
00626   int dest = p->Recv_uint32();
00627 
00628   char msg[NETWORK_CHAT_LENGTH];
00629   p->Recv_string(msg, NETWORK_CHAT_LENGTH);
00630 
00631   switch (action) {
00632     case NETWORK_ACTION_CHAT:
00633     case NETWORK_ACTION_CHAT_CLIENT:
00634     case NETWORK_ACTION_CHAT_COMPANY:
00635     case NETWORK_ACTION_SERVER_MESSAGE:
00636       NetworkServerSendChat(action, desttype, dest, msg, _network_own_client_id, 0, true);
00637       break;
00638 
00639     default:
00640       DEBUG(net, 3, "[admin] Invalid chat action %d from admin '%s' (%s).", action, this->admin_name, this->admin_version);
00641       return this->SendError(NETWORK_ERROR_ILLEGAL_PACKET);
00642   }
00643 
00644   return NETWORK_RECV_STATUS_OKAY;
00645 }
00646 
00647 /*
00648  * Useful wrapper functions
00649  */
00650 
00656 void NetworkAdminClientInfo(const NetworkClientInfo *ci, bool new_client)
00657 {
00658   ServerNetworkAdminSocketHandler *as;
00659   FOR_ALL_ADMIN_SOCKETS(as) {
00660     if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
00661       as->SendClientInfo(ci);
00662       if (new_client) {
00663         as->SendClientJoin(ci->client_id);
00664       }
00665     }
00666   }
00667 }
00668 
00673 void NetworkAdminClientUpdate(const NetworkClientInfo *ci)
00674 {
00675   ServerNetworkAdminSocketHandler *as;
00676   FOR_ALL_ADMIN_SOCKETS(as) {
00677     if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
00678       as->SendClientUpdate(ci);
00679     }
00680   }
00681 }
00682 
00687 void NetworkAdminClientQuit(ClientID client_id)
00688 {
00689   ServerNetworkAdminSocketHandler *as;
00690   FOR_ALL_ADMIN_SOCKETS(as) {
00691     if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
00692       as->SendClientQuit(client_id);
00693     }
00694   }
00695 }
00696 
00702 void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code)
00703 {
00704   ServerNetworkAdminSocketHandler *as;
00705   FOR_ALL_ADMIN_SOCKETS(as) {
00706     if (as->update_frequency[ADMIN_UPDATE_CLIENT_INFO] & ADMIN_FREQUENCY_AUTOMATIC) {
00707       as->SendClientError(client_id, error_code);
00708     }
00709   }
00710 }
00711 
00717 void NetworkAdminCompanyInfo(const Company *company, bool new_company)
00718 {
00719   if (company == NULL) {
00720     DEBUG(net, 1, "[admin] Empty company given for update");
00721     return;
00722   }
00723 
00724   ServerNetworkAdminSocketHandler *as;
00725   FOR_ALL_ADMIN_SOCKETS(as) {
00726     if (as->update_frequency[ADMIN_UPDATE_COMPANY_INFO] != ADMIN_FREQUENCY_AUTOMATIC) continue;
00727 
00728     as->SendCompanyInfo(company);
00729     if (new_company) {
00730       as->SendCompanyNew(company->index);
00731     }
00732   }
00733 }
00734 
00739 void NetworkAdminCompanyUpdate(const Company *company)
00740 {
00741   if (company == NULL) return;
00742 
00743   ServerNetworkAdminSocketHandler *as;
00744   FOR_ALL_ADMIN_SOCKETS(as) {
00745     if (as->update_frequency[ADMIN_UPDATE_COMPANY_INFO] != ADMIN_FREQUENCY_AUTOMATIC) continue;
00746 
00747     as->SendCompanyUpdate(company);
00748   }
00749 }
00750 
00756 void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
00757 {
00758   ServerNetworkAdminSocketHandler *as;
00759   FOR_ALL_ADMIN_SOCKETS(as) {
00760     as->SendCompanyRemove(company_id, bcrr);
00761   }
00762 }
00763 
00764 
00768 void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data, bool from_admin)
00769 {
00770   if (from_admin) return;
00771 
00772   ServerNetworkAdminSocketHandler *as;
00773   FOR_ALL_ADMIN_SOCKETS(as) {
00774     if (as->update_frequency[ADMIN_UPDATE_CHAT] & ADMIN_FREQUENCY_AUTOMATIC) {
00775       as->SendChat(action, desttype, client_id, msg, data);
00776     }
00777   }
00778 }
00779 
00786 void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const char *string)
00787 {
00788   ServerNetworkAdminSocketHandler::Get(admin_index)->SendRcon(colour_code, string);
00789 }
00790 
00796 void NetworkAdminConsole(const char *origin, const char *string)
00797 {
00798   ServerNetworkAdminSocketHandler *as;
00799   FOR_ALL_ADMIN_SOCKETS(as) {
00800     if (as->update_frequency[ADMIN_UPDATE_CONSOLE] & ADMIN_FREQUENCY_AUTOMATIC) {
00801       as->SendConsole(origin, string);
00802     }
00803   }
00804 }
00805 
00811 void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp)
00812 {
00813   ClientID client_id = owner == NULL ? _network_own_client_id : owner->client_id;
00814 
00815   ServerNetworkAdminSocketHandler *as;
00816   FOR_ALL_ADMIN_SOCKETS(as) {
00817     if (as->update_frequency[ADMIN_UPDATE_CMD_LOGGING] & ADMIN_FREQUENCY_AUTOMATIC) {
00818       as->SendCmdLogging(client_id, cp);
00819     }
00820   }
00821 }
00822 
00826 void ServerNetworkAdminSocketHandler::WelcomeAll()
00827 {
00828   ServerNetworkAdminSocketHandler *as;
00829   FOR_ALL_ADMIN_SOCKETS(as) {
00830     as->SendWelcome();
00831   }
00832 }
00833 
00838 void NetworkAdminUpdate(AdminUpdateFrequency freq)
00839 {
00840   ServerNetworkAdminSocketHandler *as;
00841   FOR_ALL_ADMIN_SOCKETS(as) {
00842     for (int i = 0; i < ADMIN_UPDATE_END; i++) {
00843       if (as->update_frequency[i] & freq) {
00844         /* Update the admin for the required details */
00845         switch (i) {
00846           case ADMIN_UPDATE_DATE:
00847             as->SendDate();
00848             break;
00849 
00850           case ADMIN_UPDATE_COMPANY_ECONOMY:
00851             as->SendCompanyEconomy();
00852             break;
00853 
00854           case ADMIN_UPDATE_COMPANY_STATS:
00855             as->SendCompanyStats();
00856             break;
00857 
00858           default: NOT_REACHED();
00859         }
00860       }
00861     }
00862   }
00863 }
00864 
00865 #endif /* ENABLE_NETWORK */

Generated on Sun Jan 9 16:01:56 2011 for OpenTTD by  doxygen 1.6.1