1 |
/* |
2 |
* This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 |
* |
4 |
* Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 |
* Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
6 |
* Copyright (©) 1992,2007 Frank Tore Johansen |
7 |
* |
8 |
* Deliantra is free software: you can redistribute it and/or modify it under |
9 |
* the terms of the Affero GNU General Public License as published by the |
10 |
* Free Software Foundation, either version 3 of the License, or (at your |
11 |
* option) any later version. |
12 |
* |
13 |
* This program is distributed in the hope that it will be useful, |
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 |
* GNU General Public License for more details. |
17 |
* |
18 |
* You should have received a copy of the Affero GNU General Public License |
19 |
* and the GNU General Public License along with this program. If not, see |
20 |
* <http://www.gnu.org/licenses/>. |
21 |
* |
22 |
* The authors can be reached via e-mail to <support@deliantra.net> |
23 |
*/ |
24 |
|
25 |
#ifndef CLIENT_H |
26 |
#define CLIENT_H |
27 |
|
28 |
#include <deque> |
29 |
#include <bitset> |
30 |
#include <tr1/unordered_set> |
31 |
|
32 |
#if HAVE_TCP_INFO |
33 |
# include <netinet/tcp.h> |
34 |
#else |
35 |
struct tcp_info { |
36 |
// dummy |
37 |
int tcpi_state; |
38 |
int tcpi_ca_state; |
39 |
int tcpi_retransmits; |
40 |
int tcpi_probes; |
41 |
int tcpi_backoff; |
42 |
int tcpi_options; |
43 |
int tcpi_snd_wscale; |
44 |
int tcpi_rcv_wscale; |
45 |
int tcpi_rto; |
46 |
int tcpi_ato; |
47 |
int tcpi_snd_mss; |
48 |
int tcpi_rcv_mss; |
49 |
int tcpi_unacked; |
50 |
int tcpi_sacked; |
51 |
int tcpi_lost; |
52 |
int tcpi_retrans; |
53 |
int tcpi_fackets; |
54 |
int tcpi_last_data_sent; |
55 |
int tcpi_last_ack_sent; |
56 |
int tcpi_last_data_recv; |
57 |
int tcpi_last_ack_recv; |
58 |
int tcpi_pmtu; |
59 |
int tcpi_rcv_ssthresh; |
60 |
int tcpi_rtt; |
61 |
int tcpi_rttvar; |
62 |
int tcpi_snd_ssthresh; |
63 |
int tcpi_snd_cwnd; |
64 |
int tcpi_advmss; |
65 |
int tcpi_reordering; |
66 |
}; |
67 |
#endif |
68 |
|
69 |
// (possibly) max. number of objects "per page" in the ground container |
70 |
#define FLOORBOX_PAGESIZE 50 |
71 |
|
72 |
struct MapCell |
73 |
{ |
74 |
tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
75 |
int count; /* This is really darkness in the map1 command */ |
76 |
faceidx faces[MAP_LAYERS]; |
77 |
unsigned char stat_hp; // health of something in this space, or 0 |
78 |
unsigned char flags; |
79 |
uint8_t smooth[MAP_LAYERS]; |
80 |
}; |
81 |
|
82 |
#define MAX_CLIENT_X MAP_CLIENT_X |
83 |
#define MAX_CLIENT_Y MAP_CLIENT_Y |
84 |
|
85 |
struct Map |
86 |
{ |
87 |
struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
88 |
}; |
89 |
|
90 |
/* True max is 16383 given current map compaction method */ |
91 |
#define MAXANIMNUM 10000 |
92 |
|
93 |
struct statsinfo |
94 |
{ |
95 |
char *range, *title; |
96 |
}; |
97 |
|
98 |
/* This contains basic information on the socket structure. status is its |
99 |
* current state. we set up our on buffers for sending/receiving, so we can |
100 |
* handle some higher level functions. fd is the actual file descriptor we |
101 |
* are using. |
102 |
*/ |
103 |
|
104 |
/* Only one map mode can actually be used, so lets make it a switch |
105 |
* instead of having a bunch of different fields that needed to |
106 |
* get toggled. |
107 |
*/ |
108 |
enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
109 |
|
110 |
// states the socket can be in |
111 |
enum { |
112 |
ST_DEAD, // socket is dead |
113 |
ST_SETUP, // initial handshake / setup / login |
114 |
ST_PLAYING, // logged in an playing |
115 |
ST_CUSTOM, // waiting for custom reply |
116 |
|
117 |
ST_GET_PARTY_PASSWORD, |
118 |
}; |
119 |
|
120 |
// a handler for a specific type of packet |
121 |
enum { |
122 |
PF_PLAYER = 0x01, // must have valid player / will by synchronised |
123 |
PF_PLAYING = 0x02, // must be in playing state |
124 |
PF_COMMAND0 = 0x04, // command starts at offset 0 |
125 |
PF_COMMAND6 = 0x08, // command starts at offset 6 |
126 |
}; |
127 |
|
128 |
// face type.s bit 0 means "has meta info prepended" |
129 |
enum { |
130 |
FT_FACE = 0 * 2 + 0, // faces (images) |
131 |
FT_MUSIC = 1 * 2 + 1, // background music |
132 |
FT_SOUND = 2 * 2 + 1, // effects |
133 |
FT_RSRC = 3 * 2 + 0, // generic data files |
134 |
FT_NUM, |
135 |
}; |
136 |
|
137 |
struct packet_type |
138 |
{ |
139 |
const char *name; |
140 |
void *cb; |
141 |
int flags; |
142 |
}; |
143 |
|
144 |
struct command |
145 |
{ |
146 |
tstamp stamp; |
147 |
const packet_type *handler; |
148 |
char *data; |
149 |
int datalen; |
150 |
}; |
151 |
|
152 |
/* how many times we are allowed to give the wrong password before being kicked. */ |
153 |
#define MAX_PASSWORD_FAILURES 5 |
154 |
|
155 |
INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
156 |
struct client : zero_initialised, attachable |
157 |
{ |
158 |
int ACC (RW, fd); |
159 |
unsigned int inbuf_len; // number of bytes valid in inbuf |
160 |
statsinfo stats; |
161 |
object_vector_index ACC (RO, active); |
162 |
player_ptr ACC (RO, pl); |
163 |
|
164 |
char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
165 |
uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
166 |
|
167 |
sint8 ACC (RW, last_level); /* Last level we sent to client */ |
168 |
uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */ |
169 |
float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */ |
170 |
sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */ |
171 |
sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */ |
172 |
uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */ |
173 |
uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
174 |
uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
175 |
living ACC (RO, last_stats); /* Last stats as sent to client */ |
176 |
float ACC (RW, last_speed); /* Last speed as sent to client */ |
177 |
sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
178 |
sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
179 |
|
180 |
bool ACC (RW, afk); /* player is afk */ |
181 |
bool ACC (RW, sent_scroll); |
182 |
bool ACC (RW, sound); /* does the client want sound */ |
183 |
bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
184 |
bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
185 |
bool ACC (RW, mapinfocmd); // return map info and send map change info |
186 |
uint8_t ACC (RW, extcmd); // call into extensions/plugins |
187 |
bool ACC (RW, update_look); /* If true, we need to send the look window */ |
188 |
bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
189 |
/* used to arrange text in books, scrolls, or scripted dialogs */ |
190 |
bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
191 |
bool ACC (RW, smoothing); // deliantra-style smoothing |
192 |
|
193 |
bool ACC (RW, force_newmap); // force a newmap before next map update |
194 |
uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
195 |
uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
196 |
uint16 ACC (RW, look_position); /* start of drawing of look window */ |
197 |
uint16 ACC (RW, mss); // likely tcp maximum segment size |
198 |
uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ |
199 |
uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
200 |
uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
201 |
|
202 |
maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
203 |
region_ptr ACC (RW, current_region); // CF+ last/current player region |
204 |
int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
205 |
shstr ACC (RW, version); // CF+ client name/version |
206 |
uint8 ACC (RW, faceset); // CF+ selected faceset |
207 |
|
208 |
tstamp ACC (RW, last_send); // last data send on socket. |
209 |
|
210 |
float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */ |
211 |
int ACC (RW, rate_avail); // current rate balance |
212 |
int ACC (RW, max_rate); // max. # of bytes to send per tick |
213 |
faceidx ACC (RW, scrub_idx); // which face to send next |
214 |
int ACC (RW, bg_scrub); // how many ticks till the next background face send |
215 |
|
216 |
struct tcp_info tcpi; |
217 |
tstamp next_rate_adjust; |
218 |
|
219 |
unordered_vector<char *> mapinfo_queue; |
220 |
void mapinfo_queue_clear (); |
221 |
void mapinfo_queue_run (); |
222 |
bool mapinfo_try (char *buf); |
223 |
|
224 |
struct ixsend { |
225 |
int16_t pri; // unused |
226 |
faceidx idx; |
227 |
uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
228 |
}; |
229 |
std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
230 |
|
231 |
std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
232 |
MTH void flush_fx (); // send fx if required |
233 |
|
234 |
void do_destroy (); |
235 |
void gather_callbacks (AV *&callbacks, event_type event) const; |
236 |
|
237 |
iow socket_ev; void socket_cb (iow &w, int revents); |
238 |
|
239 |
std::deque< command, slice_allocator<command> > cmd_queue; |
240 |
|
241 |
// large structures at the end please |
242 |
struct Map lastmap; |
243 |
std::bitset<MAXANIMNUM> anims_sent; |
244 |
std::bitset<MAX_FACES> faces_sent; |
245 |
std::bitset<FT_NUM> fx_want; |
246 |
|
247 |
// if we get an incomplete packet, this is used to hold the data. |
248 |
// we add 2 byte for the header, one for the trailing 0 byte |
249 |
uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
250 |
|
251 |
enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
252 |
struct msg_buf |
253 |
{ |
254 |
tick_t expire; |
255 |
int len; |
256 |
int count; |
257 |
char msg[MSG_BUF_SIZE]; |
258 |
} msgbuf[MSG_BUF_COUNT]; |
259 |
|
260 |
MTH bool msg_suppressed (const char *msg); |
261 |
|
262 |
/* The following is the setup for a ring buffer for storing output |
263 |
* data that the OS can't handle right away. |
264 |
* TODO: this member is enourmously large - optimise? |
265 |
*/ |
266 |
struct |
267 |
{ |
268 |
char data[SOCKETBUFSIZE]; |
269 |
int start; |
270 |
int len; |
271 |
} outputbuffer; |
272 |
|
273 |
bool may_execute (const packet_type *pkt) const; |
274 |
void execute (const packet_type *pkt, char *data, int datalen); |
275 |
|
276 |
void queue_command (packet_type *handler, char *data, int datalen); |
277 |
MTH bool handle_command (); |
278 |
// resets movement state |
279 |
MTH void reset_state (); |
280 |
// resets variable data used to send stat diffs |
281 |
MTH void reset_stats (); |
282 |
|
283 |
MTH bool handle_packet (); |
284 |
int next_packet (); // returns length of packet or 0 |
285 |
void skip_packet (int len); // we have processed the packet, skip it |
286 |
|
287 |
MTH void flush (); |
288 |
MTH void write_outputbuffer (); |
289 |
MTH int outputbuffer_len () const { return outputbuffer.len; } |
290 |
void send (void *buf_, int len); |
291 |
|
292 |
void send_packet (const char *buf); |
293 |
void send_packet (const char *buf, int len); |
294 |
void send_packet_printf (const char *format, ...); |
295 |
void send_packet (packet &sl); |
296 |
|
297 |
void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
298 |
|
299 |
MTH void send_face (faceidx facenum, int pri = 0); |
300 |
MTH void send_faces (object *ob); |
301 |
MTH void send_animation (short anim_num); |
302 |
void send_msg (int color, const char *type, const char *msg); |
303 |
|
304 |
MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
305 |
// called when something under the player changes |
306 |
MTH void floorbox_update () { update_look = 1; } |
307 |
// called when the player has been moved |
308 |
MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
309 |
|
310 |
MTH void tick (); // called every server tick to do housekeeping etc. |
311 |
|
312 |
MTH static client *create (int fd, const char *peername); |
313 |
MTH static void clock (); |
314 |
MTH static void flush_sockets (); |
315 |
|
316 |
protected: |
317 |
client (int fd, const char *from_ip); |
318 |
~client (); |
319 |
}; |
320 |
|
321 |
#if FOR_PERL |
322 |
ACC (RW, tcpi.tcpi_state); |
323 |
ACC (RW, tcpi.tcpi_ca_state); |
324 |
ACC (RW, tcpi.tcpi_retransmits); |
325 |
ACC (RW, tcpi.tcpi_probes); |
326 |
ACC (RW, tcpi.tcpi_backoff); |
327 |
ACC (RW, tcpi.tcpi_options); |
328 |
ACC (RO, tcpi.tcpi_snd_wscale); |
329 |
ACC (RO, tcpi.tcpi_rcv_wscale); |
330 |
ACC (RW, tcpi.tcpi_rto); |
331 |
ACC (RW, tcpi.tcpi_ato); |
332 |
ACC (RW, tcpi.tcpi_snd_mss); |
333 |
ACC (RW, tcpi.tcpi_rcv_mss); |
334 |
ACC (RW, tcpi.tcpi_unacked); |
335 |
ACC (RW, tcpi.tcpi_sacked); |
336 |
ACC (RW, tcpi.tcpi_lost); |
337 |
ACC (RW, tcpi.tcpi_retrans); |
338 |
ACC (RW, tcpi.tcpi_fackets); |
339 |
ACC (RW, tcpi.tcpi_last_data_sent); |
340 |
ACC (RW, tcpi.tcpi_last_ack_sent); |
341 |
ACC (RW, tcpi.tcpi_last_data_recv); |
342 |
ACC (RW, tcpi.tcpi_last_ack_recv); |
343 |
ACC (RW, tcpi.tcpi_pmtu); |
344 |
ACC (RW, tcpi.tcpi_rcv_ssthresh); |
345 |
ACC (RW, tcpi.tcpi_rtt); |
346 |
ACC (RW, tcpi.tcpi_rttvar); |
347 |
ACC (RW, tcpi.tcpi_snd_ssthresh); |
348 |
ACC (RW, tcpi.tcpi_snd_cwnd); |
349 |
ACC (RW, tcpi.tcpi_advmss); |
350 |
ACC (RW, tcpi.tcpi_reordering); |
351 |
#endif |
352 |
|
353 |
#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
354 |
( ((__type)>0) &&\ |
355 |
((__sockPtr)->has_readable_type) && \ |
356 |
((__sockPtr)->supported_readables & (1<<(__type))) ) |
357 |
|
358 |
#define FACE_TYPES 1 |
359 |
#define PNG_FACE_INDEX 0 |
360 |
|
361 |
#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
362 |
#define VERSION_SC 1026 |
363 |
//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
364 |
#define VERSION_INFO "Deliantra Server" |
365 |
|
366 |
typedef object_vector<client, &client::active> sockvec; |
367 |
|
368 |
extern sockvec clients; |
369 |
|
370 |
#define for_all_clients(var) \ |
371 |
for (int _i = 0; _i < clients.size (); ++_i) \ |
372 |
statementvar (client *, var, clients [_i]) |
373 |
|
374 |
// returns true when the message needs special (read: perl) treatment |
375 |
static inline bool |
376 |
msg_is_special (const char *msg, bool nl_special = true) |
377 |
{ |
378 |
return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; |
379 |
} |
380 |
|
381 |
#endif |
382 |
|