1

/* $Id$ */

     2

     3

#ifndef NETWORK_H

     4

#define NETWORK_H

     5

     6

#define NOREV_STRING "norev000"

     7

     8

#ifdef ENABLE_NETWORK

     9

    10

#include "player.h"

    11

    12

// If this line is enable, every frame will have a sync test

    13

//  this is not needed in normal games. Normal is like 1 sync in 100

    14

//  frames. You can enable this if you have a lot of desyncs on a certain

    15

//  game.

    16

// Remember: both client and server have to be compiled with this

    17

//  option enabled to make it to work. If one of the two has it disabled

    18

//  nothing will happen.

    19

//#define ENABLE_NETWORK_SYNC_EVERY_FRAME

    20

    21

// In theory sending 1 of the 2 seeds is enough to check for desyncs

    22

//   so in theory, this next define can be left off.

    23

//#define NETWORK_SEND_DOUBLE_SEED

    24

    25

// How many clients can we have? Like.. MAX_PLAYERS - 1 is the amount of

    26

//  players that can really play.. so.. a max of 4 spectators.. gives us..

    27

//  MAX_PLAYERS + 3

    28

#define MAX_CLIENTS (MAX_PLAYERS + 3)

    29

    30

    31

// Do not change this next line. It should _ALWAYS_ be MAX_CLIENTS + 1

    32

#define MAX_CLIENT_INFO (MAX_CLIENTS + 1)

    33

    34

/* Stuff for the master-server */

    35

#define NETWORK_MASTER_SERVER_PORT 3978

    36

#define NETWORK_MASTER_SERVER_HOST "master.openttd.org"

    37

#define NETWORK_MASTER_SERVER_WELCOME_MESSAGE "OpenTTDRegister"

    38

    39

#define NETWORK_DEFAULT_PORT 3979

    40

    41

#define MAX_INTERFACES 9

    42

    43

    44

// How many vehicle/station types we put over the network

    45

#define NETWORK_VEHICLE_TYPES 5

    46

#define NETWORK_STATION_TYPES 5

    47

    48

enum {

    49

	NETWORK_NAME_LENGTH        = 80,

    50

	NETWORK_HOSTNAME_LENGTH    = 80,

    51

	NETWORK_REVISION_LENGTH    = 10,

    52

	NETWORK_PASSWORD_LENGTH    = 20,

    53

	NETWORK_PLAYERS_LENGTH     = 200,

    54

	NETWORK_CLIENT_NAME_LENGTH = 25,

    55

	NETWORK_RCONCOMMAND_LENGTH = 500,

    56

    57

	NETWORK_NUM_LANGUAGES      = 4,

    58

};

    59

    60

// This is the struct used by both client and server

    61

//  some fields will be empty on the client (like game_password) by default

    62

//  and only filled with data a player enters.

    63

typedef struct NetworkGameInfo {

    64

	char server_name[NETWORK_NAME_LENGTH];					// Server name

    65

	char hostname[NETWORK_HOSTNAME_LENGTH];					// Hostname of the server (if any)

    66

	char server_revision[NETWORK_REVISION_LENGTH];	// The SVN version number the server is using (e.g.: 'r304')

    67

																									//  It even shows a SVN version in release-version, so

    68

																									//  it is easy to compare if a server is of the correct version

    69

	byte server_lang;																// Language of the server (we should make a nice table for this)

    70

	byte use_password;															// Is set to != 0 if it uses a password

    71

	char server_password[NETWORK_PASSWORD_LENGTH];	// On the server: the game password, on the client: != "" if server has password

    72

	byte clients_max;																// Max clients allowed on server

    73

	byte clients_on;																// Current count of clients on server

    74

	byte spectators_on;															// How many spectators do we have?

    75

	uint16 game_date;																// Current date

    76

	uint16 start_date;															// When the game started

    77

	char map_name[NETWORK_NAME_LENGTH];							// Map which is played ["random" for a randomized map]

    78

	uint16 map_width;																// Map width

    79

	uint16 map_height;															// Map height

    80

	byte map_set;																		// Graphical set

    81

	bool dedicated;																	// Is this a dedicated server?

    82

	char rcon_password[NETWORK_PASSWORD_LENGTH];		// RCon password for the server. "" if rcon is disabled

    83

} NetworkGameInfo;

    84

    85

typedef struct NetworkPlayerInfo {

    86

	char company_name[NETWORK_NAME_LENGTH];					// Company name

    87

	char password[NETWORK_PASSWORD_LENGTH];					// The password for the player

    88

	byte inaugurated_year;													// What year the company started in

    89

	int64 company_value;														// The company value

    90

	int64 money;																		// The amount of money the company has

    91

	int64 income;																		// How much did the company earned last year

    92

	uint16 performance;															// What was his performance last month?

    93

	byte use_password;													// 0: No password 1: There is a password

    94

	uint16 num_vehicle[NETWORK_VEHICLE_TYPES];			// How many vehicles are there of this type?

    95

	uint16 num_station[NETWORK_STATION_TYPES];			// How many stations are there of this type?

    96

	char players[NETWORK_PLAYERS_LENGTH];						// The players that control this company (Name1, name2, ..)

    97

	uint16 months_empty;														// How many months the company is empty

    98

} NetworkPlayerInfo;

    99

   100

typedef struct NetworkClientInfo {

   101

	uint16 client_index;                          /// Index of the client (same as ClientState->index)

   102

	char client_name[NETWORK_CLIENT_NAME_LENGTH]; /// Name of the client

   103

	byte client_lang;                             /// The language of the client

   104

	byte client_playas;                           /// As which player is this client playing (PlayerID)

   105

	uint32 client_ip;                             /// IP-address of the client (so he can be banned)

   106

	uint16 join_date;                             /// Gamedate the player has joined

   107

	char unique_id[NETWORK_NAME_LENGTH];          /// Every play sends an unique id so we can indentify him

   108

} NetworkClientInfo;

   109

   110

typedef struct NetworkGameList {

   111

	NetworkGameInfo info;

   112

	uint32 ip;

   113

	uint16 port;

   114

	bool online;																		// False if the server did not respond (default status)

   115

	bool manually;																	// True if the server was added manually

   116

	struct NetworkGameList *next;

   117

} NetworkGameList;

   118

   119

typedef enum {

   120

	NETWORK_JOIN_STATUS_CONNECTING,

   121

	NETWORK_JOIN_STATUS_AUTHORIZING,

   122

	NETWORK_JOIN_STATUS_WAITING,

   123

	NETWORK_JOIN_STATUS_DOWNLOADING,

   124

	NETWORK_JOIN_STATUS_PROCESSING,

   125

	NETWORK_JOIN_STATUS_REGISTERING,

   126

   127

	NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO,

   128

} NetworkJoinStatus;

   129

   130

// language ids for server_lang and client_lang

   131

typedef enum {

   132

	NETLANG_ANY = 0,

   133

	NETLANG_ENGLISH = 1,

   134

	NETLANG_GERMAN = 2,

   135

	NETLANG_FRENCH = 3,

   136

} NetworkLanguage;

   137

   138

VARDEF NetworkGameList *_network_game_list;

   139

   140

VARDEF NetworkGameInfo _network_game_info;

   141

VARDEF NetworkPlayerInfo _network_player_info[MAX_PLAYERS];

   142

VARDEF NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

   143

   144

VARDEF char _network_player_name[NETWORK_NAME_LENGTH];

   145

VARDEF char _network_default_ip[NETWORK_HOSTNAME_LENGTH];

   146

   147

VARDEF uint16 _network_own_client_index;

   148

VARDEF char _network_unique_id[NETWORK_NAME_LENGTH]; // Our own unique ID

   149

   150

VARDEF uint32 _frame_counter_server; // The frame_counter of the server, if in network-mode

   151

VARDEF uint32 _frame_counter_max; // To where we may go with our clients

   152

   153

VARDEF uint32 _last_sync_frame; // Used in the server to store the last time a sync packet was sent to clients.

   154

   155

// networking settings

   156

VARDEF uint32 _network_ip_list[MAX_INTERFACES + 1]; // Network IPs

   157

VARDEF uint16 _network_game_count;

   158

   159

VARDEF uint16 _network_lobby_company_count;

   160

   161

VARDEF uint _network_server_port;

   162

/* We use bind_ip and bind_ip_host, where bind_ip_host is the readable form of

   163

    bind_ip_host, and bind_ip the numeric value, because we want a nice number

   164

    in the openttd.cfg, but we wants to use the uint32 internally.. */

   165

VARDEF uint32 _network_server_bind_ip;

   166

VARDEF char _network_server_bind_ip_host[NETWORK_HOSTNAME_LENGTH];

   167

VARDEF bool _is_network_server; // Does this client wants to be a network-server?

   168

VARDEF char _network_server_name[NETWORK_NAME_LENGTH];

   169

VARDEF char _network_server_password[NETWORK_PASSWORD_LENGTH];

   170

VARDEF char _network_rcon_password[NETWORK_PASSWORD_LENGTH];

   171

   172

VARDEF uint16 _network_max_join_time;             //! Time a client can max take to join

   173

VARDEF bool _network_pause_on_join;               //! Pause the game when a client tries to join (more chance of succeeding join)

   174

   175

VARDEF uint16 _redirect_console_to_client;

   176

   177

VARDEF uint16 _network_sync_freq;

   178

VARDEF uint8 _network_frame_freq;

   179

   180

VARDEF uint32 _sync_seed_1, _sync_seed_2;

   181

VARDEF uint32 _sync_frame;

   182

VARDEF bool _network_first_time;

   183

// Vars needed for the join-GUI

   184

VARDEF NetworkJoinStatus _network_join_status;

   185

VARDEF uint8 _network_join_waiting;

   186

VARDEF uint16 _network_join_kbytes;

   187

VARDEF uint16 _network_join_kbytes_total;

   188

   189

VARDEF char _network_last_host[NETWORK_HOSTNAME_LENGTH];

   190

VARDEF short _network_last_port;

   191

VARDEF uint32 _network_last_host_ip;

   192

VARDEF uint8 _network_reconnect;

   193

   194

VARDEF bool _network_udp_server;

   195

VARDEF uint16 _network_udp_broadcast;

   196

   197

VARDEF byte _network_lan_internet;

   198

   199

VARDEF bool _network_advertise;

   200

VARDEF uint16 _network_last_advertise_date;

   201

VARDEF uint8 _network_advertise_retries;

   202

   203

VARDEF bool _network_autoclean_companies;

   204

VARDEF uint8 _network_autoclean_unprotected; // Remove a company after X months

   205

VARDEF uint8 _network_autoclean_protected;   // Unprotect a company after X months

   206

   207

VARDEF uint16 _network_restart_game_date;    // If this year is reached, the server automaticly restarts

   208

   209

NetworkGameList *NetworkQueryServer(const char* host, unsigned short port, bool game_info);

   210

void CSleep(int milliseconds);

   211

   212

#endif /* ENABLE_NETWORK */

   213

   214

// Those variables must always be registered!

   215

#define MAX_SAVED_SERVERS 10

   216

VARDEF char *_network_host_list[MAX_SAVED_SERVERS];

   217

#define MAX_BANS 25

   218

VARDEF char *_network_ban_list[MAX_BANS];

   219

VARDEF bool _networking;

   220

VARDEF bool _network_available;  // is network mode available?

   221

VARDEF bool _network_server; // network-server is active

   222

VARDEF bool _network_dedicated; // are we a dedicated server?

   223

VARDEF byte _network_playas; // an id to play as..

   224

   225

void ParseConnectionString(const char **player, const char **port, char *connection_string);

   226

void NetworkUpdateClientInfo(uint16 client_index);

   227

void NetworkAddServer(const char *b);

   228

void NetworkRebuildHostList(void);

   229

bool NetworkChangeCompanyPassword(byte argc, char *argv[]);

   230

   231

#endif /* NETWORK_H */