1 | /* |
1 | /* |
2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 | * |
3 | * |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
4 | * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
7 | * |
7 | * |
8 | * Crossfire TRT is free software: you can redistribute it and/or modify |
8 | * Deliantra is free software: you can redistribute it and/or modify |
9 | * it under the terms of the GNU General Public License as published by |
9 | * it under the terms of the GNU General Public License as published by |
10 | * the Free Software Foundation, either version 3 of the License, or |
10 | * the Free Software Foundation, either version 3 of the License, or |
11 | * (at your option) any later version. |
11 | * (at your option) any later version. |
12 | * |
12 | * |
13 | * This program is distributed in the hope that it will be useful, |
13 | * This program is distributed in the hope that it will be useful, |
… | |
… | |
16 | * GNU General Public License for more details. |
16 | * GNU General Public License for more details. |
17 | * |
17 | * |
18 | * You should have received a copy of the GNU General Public License |
18 | * You should have received a copy of the GNU General Public License |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
20 | * |
20 | * |
21 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
21 | * The authors can be reached via e-mail to <support@deliantra.net> |
22 | */ |
22 | */ |
23 | |
23 | |
24 | #ifndef CLIENT_H |
24 | #ifndef CLIENT_H |
25 | #define CLIENT_H |
25 | #define CLIENT_H |
26 | |
26 | |
… | |
… | |
29 | #include <tr1/unordered_set> |
29 | #include <tr1/unordered_set> |
30 | |
30 | |
31 | #if HAVE_TCP_INFO |
31 | #if HAVE_TCP_INFO |
32 | # include <netinet/tcp.h> |
32 | # include <netinet/tcp.h> |
33 | #else |
33 | #else |
34 | struct tcpi_info { |
34 | struct tcp_info { |
35 | // dummy |
35 | // dummy |
36 | char tcpi_state; |
36 | int tcpi_state; |
37 | char tcpi_ca_state; |
37 | int tcpi_ca_state; |
38 | char tcpi_retransmits; |
38 | int tcpi_retransmits; |
39 | char tcpi_probes; |
39 | int tcpi_probes; |
40 | char tcpi_backoff; |
40 | int tcpi_backoff; |
41 | char tcpi_options; |
41 | int tcpi_options; |
42 | char tcpi_snd_wscale; |
42 | int tcpi_snd_wscale; |
43 | char tcpi_rcv_wscale; |
43 | int tcpi_rcv_wscale; |
44 | char tcpi_rto; |
44 | int tcpi_rto; |
45 | char tcpi_ato; |
45 | int tcpi_ato; |
46 | char tcpi_snd_mss; |
46 | int tcpi_snd_mss; |
47 | char tcpi_rcv_mss; |
47 | int tcpi_rcv_mss; |
48 | char tcpi_unacked; |
48 | int tcpi_unacked; |
49 | char tcpi_sacked; |
49 | int tcpi_sacked; |
50 | char tcpi_lost; |
50 | int tcpi_lost; |
51 | char tcpi_retrans; |
51 | int tcpi_retrans; |
52 | char tcpi_fackets; |
52 | int tcpi_fackets; |
53 | char tcpi_last_data_sent; |
53 | int tcpi_last_data_sent; |
54 | char tcpi_last_ack_sent; |
54 | int tcpi_last_ack_sent; |
55 | char tcpi_last_data_recv; |
55 | int tcpi_last_data_recv; |
56 | char tcpi_last_ack_recv; |
56 | int tcpi_last_ack_recv; |
57 | char tcpi_pmtu; |
57 | int tcpi_pmtu; |
58 | char tcpi_rcv_ssthresh; |
58 | int tcpi_rcv_ssthresh; |
59 | char tcpi_rtt; |
59 | int tcpi_rtt; |
60 | char tcpi_rttvar; |
60 | int tcpi_rttvar; |
61 | char tcpi_snd_ssthresh; |
61 | int tcpi_snd_ssthresh; |
62 | char tcpi_snd_cwnd; |
62 | int tcpi_snd_cwnd; |
63 | char tcpi_advmss; |
63 | int tcpi_advmss; |
64 | char tcpi_reordering; |
64 | int tcpi_reordering; |
65 | }; |
65 | }; |
66 | #endif |
66 | #endif |
67 | |
67 | |
68 | // (possibly) max. number of objects "per page" in the ground container |
68 | // (possibly) max. number of objects "per page" in the ground container |
69 | #define FLOORBOX_PAGESIZE 50 |
69 | #define FLOORBOX_PAGESIZE 50 |
70 | |
70 | |
71 | struct MapCell |
71 | struct MapCell |
72 | { |
72 | { |
73 | tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
73 | tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
74 | int count; /* This is really darkness in the map1 command */ |
74 | int count; /* This is really darkness in the map1 command */ |
75 | faceidx faces[MAP_LAYERS]; |
75 | faceidx faces[MAP_LAYERS]; |
76 | unsigned char stat_hp; // health of something in this space, or 0 |
76 | unsigned char stat_hp; // health of something in this space, or 0 |
77 | unsigned char flags; |
77 | unsigned char flags; |
78 | uint8_t smooth[MAP_LAYERS]; |
78 | uint8_t smooth[MAP_LAYERS]; |
… | |
… | |
144 | { |
144 | { |
145 | tstamp stamp; |
145 | tstamp stamp; |
146 | const packet_type *handler; |
146 | const packet_type *handler; |
147 | char *data; |
147 | char *data; |
148 | int datalen; |
148 | int datalen; |
149 | |
|
|
150 | ~command () |
|
|
151 | { |
|
|
152 | sfree<char> (data, datalen + 1); |
|
|
153 | } |
|
|
154 | }; |
149 | }; |
155 | |
150 | |
156 | /* how many times we are allowed to give the wrong password before being kicked. */ |
151 | /* how many times we are allowed to give the wrong password before being kicked. */ |
157 | #define MAX_PASSWORD_FAILURES 5 |
152 | #define MAX_PASSWORD_FAILURES 5 |
158 | |
153 | |
… | |
… | |
162 | int ACC (RW, fd); |
157 | int ACC (RW, fd); |
163 | unsigned int inbuf_len; // number of bytes valid in inbuf |
158 | unsigned int inbuf_len; // number of bytes valid in inbuf |
164 | statsinfo stats; |
159 | statsinfo stats; |
165 | object_vector_index ACC (RO, active); |
160 | object_vector_index ACC (RO, active); |
166 | player_ptr ACC (RO, pl); |
161 | player_ptr ACC (RO, pl); |
167 | |
|
|
168 | /* The following is the setup for a ring buffer for storing output |
|
|
169 | * data that the OS can't handle right away. |
|
|
170 | */ |
|
|
171 | struct |
|
|
172 | { |
|
|
173 | char data[SOCKETBUFSIZE]; |
|
|
174 | int start; |
|
|
175 | int len; |
|
|
176 | } outputbuffer; |
|
|
177 | |
162 | |
178 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
163 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
179 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
164 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
180 | |
165 | |
181 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
166 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
… | |
… | |
227 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
212 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
228 | uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ |
213 | uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ |
229 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
214 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
230 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
215 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
231 | |
216 | |
232 | maptile *ACC (RW, current_map); // CF+ last/current player map |
217 | maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
233 | region *ACC (RW, current_region); // CF+ last/current player region |
218 | region_ptr ACC (RW, current_region); // CF+ last/current player region |
234 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
219 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
235 | shstr ACC (RW, version); // CF+ client name/version |
220 | shstr ACC (RW, version); // CF+ client name/version |
236 | uint8 ACC (RW, faceset); // CF+ selected faceset |
221 | uint8 ACC (RW, faceset); // CF+ selected faceset |
237 | |
222 | |
238 | tstamp ACC (RW, last_send); // last data send on socket. |
223 | tstamp ACC (RW, last_send); // last data send on socket. |
… | |
… | |
242 | faceidx ACC (RW, scrub_idx); // which face to send next |
227 | faceidx ACC (RW, scrub_idx); // which face to send next |
243 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
228 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
244 | |
229 | |
245 | struct tcp_info tcpi; |
230 | struct tcp_info tcpi; |
246 | tstamp next_rate_adjust; |
231 | tstamp next_rate_adjust; |
|
|
232 | |
|
|
233 | unordered_vector<char *> mapinfo_queue; |
|
|
234 | void mapinfo_queue_clear (); |
|
|
235 | void mapinfo_queue_run (); |
|
|
236 | bool mapinfo_try (char *buf); |
|
|
237 | |
|
|
238 | struct ixsend { |
|
|
239 | int16_t pri; // unused |
|
|
240 | faceidx idx; |
|
|
241 | uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
|
|
242 | }; |
|
|
243 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
|
|
244 | |
|
|
245 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
|
|
246 | MTH void flush_fx (); // send fx if required |
|
|
247 | |
|
|
248 | void do_destroy (); |
|
|
249 | void gather_callbacks (AV *&callbacks, event_type event) const; |
|
|
250 | |
|
|
251 | iow socket_ev; void socket_cb (iow &w, int revents); |
|
|
252 | |
|
|
253 | std::deque< command, slice_allocator<command> > cmd_queue; |
|
|
254 | |
|
|
255 | // large structures at the end please |
|
|
256 | struct Map lastmap; |
|
|
257 | std::bitset<MAXANIMNUM> anims_sent; |
|
|
258 | std::bitset<MAX_FACES> faces_sent; |
|
|
259 | std::bitset<FT_NUM> fx_want; |
|
|
260 | |
|
|
261 | // if we get an incomplete packet, this is used to hold the data. |
|
|
262 | // we add 2 byte for the header, one for the trailing 0 byte |
|
|
263 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
|
|
264 | |
|
|
265 | enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
|
|
266 | struct msg_buf |
|
|
267 | { |
|
|
268 | tick_t expire; |
|
|
269 | int len; |
|
|
270 | int count; |
|
|
271 | char msg[MSG_BUF_SIZE]; |
|
|
272 | } msgbuf[MSG_BUF_COUNT]; |
|
|
273 | |
|
|
274 | MTH bool msg_suppressed (const char *msg); |
|
|
275 | |
|
|
276 | /* The following is the setup for a ring buffer for storing output |
|
|
277 | * data that the OS can't handle right away. |
|
|
278 | * TODO: this member is enourmously large - optimise? |
|
|
279 | */ |
|
|
280 | struct |
|
|
281 | { |
|
|
282 | char data[SOCKETBUFSIZE]; |
|
|
283 | int start; |
|
|
284 | int len; |
|
|
285 | } outputbuffer; |
|
|
286 | |
|
|
287 | bool may_execute (const packet_type *pkt) const; |
|
|
288 | void execute (const packet_type *pkt, char *data, int datalen); |
|
|
289 | |
|
|
290 | void queue_command (packet_type *handler, char *data, int datalen); |
|
|
291 | MTH bool handle_command (); |
|
|
292 | // resets movement state |
|
|
293 | MTH void reset_state (); |
|
|
294 | // resets variable data used to send stat diffs |
|
|
295 | MTH void reset_stats (); |
|
|
296 | |
|
|
297 | MTH bool handle_packet (); |
|
|
298 | int next_packet (); // returns length of packet or 0 |
|
|
299 | void skip_packet (int len); // we have processed the packet, skip it |
|
|
300 | |
|
|
301 | MTH void flush (); |
|
|
302 | MTH void write_outputbuffer (); |
|
|
303 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
|
|
304 | void send (void *buf_, int len); |
|
|
305 | |
|
|
306 | void send_packet (const char *buf); |
|
|
307 | void send_packet (const char *buf, int len); |
|
|
308 | void send_packet_printf (const char *format, ...); |
|
|
309 | void send_packet (packet &sl); |
|
|
310 | |
|
|
311 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
|
|
312 | |
|
|
313 | MTH void send_face (faceidx facenum, int pri = 0); |
|
|
314 | MTH void send_image (faceidx facenum); |
|
|
315 | MTH void send_faces (object *ob); |
|
|
316 | MTH void send_animation (short anim_num); |
|
|
317 | void send_msg (int color, const char *type, const char *msg); |
|
|
318 | |
|
|
319 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
|
|
320 | // called when something under the player changes |
|
|
321 | MTH void floorbox_update () { update_look = 1; } |
|
|
322 | // called when the player has been moved |
|
|
323 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
|
|
324 | |
|
|
325 | MTH void tick (); // called every server tick to do housekeeping etc. |
|
|
326 | |
|
|
327 | MTH static client *create (int fd, const char *peername); |
|
|
328 | MTH static void clock (); |
|
|
329 | MTH static void flush_sockets (); |
|
|
330 | |
|
|
331 | protected: |
|
|
332 | client (int fd, const char *from_ip); |
|
|
333 | ~client (); |
|
|
334 | }; |
|
|
335 | |
247 | #if FOR_PERL |
336 | #if FOR_PERL |
248 | // unfortunately, this emans that we *require* tcp_info now... |
|
|
249 | ACC (RW, tcpi.tcpi_state); |
337 | ACC (RW, tcpi.tcpi_state); |
250 | ACC (RW, tcpi.tcpi_ca_state); |
338 | ACC (RW, tcpi.tcpi_ca_state); |
251 | ACC (RW, tcpi.tcpi_retransmits); |
339 | ACC (RW, tcpi.tcpi_retransmits); |
252 | ACC (RW, tcpi.tcpi_probes); |
340 | ACC (RW, tcpi.tcpi_probes); |
253 | ACC (RW, tcpi.tcpi_backoff); |
341 | ACC (RW, tcpi.tcpi_backoff); |
… | |
… | |
275 | ACC (RW, tcpi.tcpi_snd_cwnd); |
363 | ACC (RW, tcpi.tcpi_snd_cwnd); |
276 | ACC (RW, tcpi.tcpi_advmss); |
364 | ACC (RW, tcpi.tcpi_advmss); |
277 | ACC (RW, tcpi.tcpi_reordering); |
365 | ACC (RW, tcpi.tcpi_reordering); |
278 | #endif |
366 | #endif |
279 | |
367 | |
280 | struct ixsend { |
|
|
281 | int16_t pri; // unused |
|
|
282 | faceidx idx; |
|
|
283 | uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
|
|
284 | }; |
|
|
285 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
|
|
286 | |
|
|
287 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
|
|
288 | MTH void flush_fx (); // send fx if required |
|
|
289 | |
|
|
290 | void do_destroy (); |
|
|
291 | void gather_callbacks (AV *&callbacks, event_type event) const; |
|
|
292 | |
|
|
293 | iow socket_ev; void socket_cb (iow &w, int got); |
|
|
294 | iw cmd_ev; void cmd_cb (iw &w); |
|
|
295 | |
|
|
296 | std::deque< command, slice_allocator<command> > cmd_queue; |
|
|
297 | |
|
|
298 | // large structures at the end please |
|
|
299 | struct Map lastmap; |
|
|
300 | std::bitset<MAXANIMNUM> anims_sent; |
|
|
301 | std::bitset<MAX_FACES> faces_sent; |
|
|
302 | std::bitset<FT_NUM> fx_want; |
|
|
303 | |
|
|
304 | // if we get an incomplete packet, this is used to hold the data. |
|
|
305 | // we add 2 byte for the header, one for the trailing 0 byte |
|
|
306 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
|
|
307 | |
|
|
308 | enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
|
|
309 | struct msg_buf |
|
|
310 | { |
|
|
311 | tick_t expire; |
|
|
312 | int len; |
|
|
313 | int count; |
|
|
314 | char msg[MSG_BUF_SIZE]; |
|
|
315 | } msgbuf[MSG_BUF_COUNT]; |
|
|
316 | |
|
|
317 | MTH bool msg_suppressed (const char *msg); |
|
|
318 | |
|
|
319 | bool may_execute (const packet_type *pkt) const; |
|
|
320 | void execute (const packet_type *pkt, char *data, int datalen); |
|
|
321 | |
|
|
322 | void queue_command (packet_type *handler, char *data, int datalen); |
|
|
323 | MTH bool handle_command (); |
|
|
324 | // resets movement state |
|
|
325 | MTH void reset_state (); |
|
|
326 | // resets variable data used to send stat diffs |
|
|
327 | MTH void reset_stats (); |
|
|
328 | |
|
|
329 | MTH bool handle_packet (); |
|
|
330 | int next_packet (); // returns length of packet or 0 |
|
|
331 | void skip_packet (int len); // we have processed the packet, skip it |
|
|
332 | |
|
|
333 | MTH void flush (); |
|
|
334 | MTH void write_outputbuffer (); |
|
|
335 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
|
|
336 | void send (void *buf_, int len); |
|
|
337 | |
|
|
338 | void send_packet (const char *buf); |
|
|
339 | void send_packet (const char *buf, int len); |
|
|
340 | void send_packet_printf (const char *format, ...); |
|
|
341 | void send_packet (packet &sl); |
|
|
342 | |
|
|
343 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
|
|
344 | |
|
|
345 | MTH void send_face (faceidx facenum, int pri = 0); |
|
|
346 | MTH void send_image (faceidx facenum); |
|
|
347 | MTH void send_faces (object *ob); |
|
|
348 | MTH void send_animation (short anim_num); |
|
|
349 | void send_msg (int color, const char *type, const char *msg); |
|
|
350 | |
|
|
351 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
|
|
352 | // called when something under the player changes |
|
|
353 | MTH void floorbox_update () { update_look = 1; } |
|
|
354 | // called when the player has been moved |
|
|
355 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
|
|
356 | |
|
|
357 | MTH void tick (); // called every server tick to do housekeeping etc. |
|
|
358 | |
|
|
359 | MTH static client *create (int fd, const char *peername); |
|
|
360 | MTH static void clock (); |
|
|
361 | MTH static void flush_sockets (); |
|
|
362 | |
|
|
363 | protected: |
|
|
364 | client (int fd, const char *from_ip); |
|
|
365 | ~client (); |
|
|
366 | }; |
|
|
367 | |
|
|
368 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
368 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
369 | ( ((__type)>0) &&\ |
369 | ( ((__type)>0) &&\ |
370 | ((__sockPtr)->has_readable_type) && \ |
370 | ((__sockPtr)->has_readable_type) && \ |
371 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
371 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
372 | |
372 | |
… | |
… | |
400 | #define PNG_FACE_INDEX 0 |
400 | #define PNG_FACE_INDEX 0 |
401 | |
401 | |
402 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
402 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
403 | #define VERSION_SC 1026 |
403 | #define VERSION_SC 1026 |
404 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
404 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
405 | #define VERSION_INFO "Crossfire TRT Server" |
405 | #define VERSION_INFO "Deliantra Server" |
406 | |
406 | |
407 | typedef object_vector<client, &client::active> sockvec; |
407 | typedef object_vector<client, &client::active> sockvec; |
408 | |
408 | |
409 | extern sockvec clients; |
409 | extern sockvec clients; |
410 | |
410 | |
411 | #define for_all_clients(var) \ |
411 | #define for_all_clients(var) \ |
412 | for (int _i = 0; _i < clients.size (); ++_i) \ |
412 | for (int _i = 0; _i < clients.size (); ++_i) \ |
413 | statementvar (client *, var, clients [_i]) |
413 | statementvar (client *, var, clients [_i]) |
414 | |
414 | |
|
|
415 | // returns true when the message needs special (read: perl) treatment |
|
|
416 | static inline bool |
|
|
417 | msg_is_special (const char *msg, bool nl_special = true) |
|
|
418 | { |
|
|
419 | return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; |
|
|
420 | } |
|
|
421 | |
415 | #endif |
422 | #endif |
416 | |
423 | |