1 | /* |
1 | /* |
2 | * CrossFire, A Multiplayer game for the X Window System |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 | * |
3 | * |
4 | * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 | * Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
6 | * Copyright (C) 1992 Frank Tore Johansen |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
7 | * |
7 | * |
8 | * This program 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 2 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, |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
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, write to the Free Software |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
20 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
21 | * |
20 | * |
22 | * The author can be reached via e-mail to crossfire@schmorp.de |
21 | * The authors can be reached via e-mail to <support@deliantra.net> |
23 | */ |
22 | */ |
24 | |
23 | |
25 | #ifndef CLIENT_H |
24 | #ifndef CLIENT_H |
26 | #define CLIENT_H |
25 | #define CLIENT_H |
27 | |
26 | |
28 | #include <deque> |
27 | #include <deque> |
29 | #include <bitset> |
28 | #include <bitset> |
30 | #include <tr1/unordered_set> |
29 | #include <tr1/unordered_set> |
|
|
30 | |
|
|
31 | #if HAVE_TCP_INFO |
|
|
32 | # include <netinet/tcp.h> |
|
|
33 | #else |
|
|
34 | struct tcp_info { |
|
|
35 | // dummy |
|
|
36 | int tcpi_state; |
|
|
37 | int tcpi_ca_state; |
|
|
38 | int tcpi_retransmits; |
|
|
39 | int tcpi_probes; |
|
|
40 | int tcpi_backoff; |
|
|
41 | int tcpi_options; |
|
|
42 | int tcpi_snd_wscale; |
|
|
43 | int tcpi_rcv_wscale; |
|
|
44 | int tcpi_rto; |
|
|
45 | int tcpi_ato; |
|
|
46 | int tcpi_snd_mss; |
|
|
47 | int tcpi_rcv_mss; |
|
|
48 | int tcpi_unacked; |
|
|
49 | int tcpi_sacked; |
|
|
50 | int tcpi_lost; |
|
|
51 | int tcpi_retrans; |
|
|
52 | int tcpi_fackets; |
|
|
53 | int tcpi_last_data_sent; |
|
|
54 | int tcpi_last_ack_sent; |
|
|
55 | int tcpi_last_data_recv; |
|
|
56 | int tcpi_last_ack_recv; |
|
|
57 | int tcpi_pmtu; |
|
|
58 | int tcpi_rcv_ssthresh; |
|
|
59 | int tcpi_rtt; |
|
|
60 | int tcpi_rttvar; |
|
|
61 | int tcpi_snd_ssthresh; |
|
|
62 | int tcpi_snd_cwnd; |
|
|
63 | int tcpi_advmss; |
|
|
64 | int tcpi_reordering; |
|
|
65 | }; |
|
|
66 | #endif |
31 | |
67 | |
32 | // (possibly) max. number of objects "per page" in the ground container |
68 | // (possibly) max. number of objects "per page" in the ground container |
33 | #define FLOORBOX_PAGESIZE 50 |
69 | #define FLOORBOX_PAGESIZE 50 |
34 | |
70 | |
35 | struct MapCell |
71 | struct MapCell |
… | |
… | |
86 | PF_PLAYING = 0x02, // must be in playing state |
122 | PF_PLAYING = 0x02, // must be in playing state |
87 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
123 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
88 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
124 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
89 | }; |
125 | }; |
90 | |
126 | |
|
|
127 | // face type.s bit 0 means "has meta info prepended" |
|
|
128 | enum { |
|
|
129 | FT_FACE = 0 * 2 + 0, // faces (images) |
|
|
130 | FT_MUSIC = 1 * 2 + 1, // background music |
|
|
131 | FT_SOUND = 2 * 2 + 1, // effects |
|
|
132 | FT_RSRC = 3 * 2 + 0, // generic data files |
|
|
133 | FT_NUM, |
|
|
134 | }; |
|
|
135 | |
91 | struct packet_type |
136 | struct packet_type |
92 | { |
137 | { |
93 | const char *name; |
138 | const char *name; |
94 | void *cb; |
139 | void *cb; |
95 | int flags; |
140 | int flags; |
… | |
… | |
99 | { |
144 | { |
100 | tstamp stamp; |
145 | tstamp stamp; |
101 | const packet_type *handler; |
146 | const packet_type *handler; |
102 | char *data; |
147 | char *data; |
103 | int datalen; |
148 | int datalen; |
104 | |
|
|
105 | ~command () |
|
|
106 | { |
|
|
107 | sfree<char> (data, datalen + 1); |
|
|
108 | } |
|
|
109 | }; |
|
|
110 | |
|
|
111 | struct refitem |
|
|
112 | { |
|
|
113 | object_ptr op; |
|
|
114 | }; |
|
|
115 | |
|
|
116 | // this represents a container on the client side. |
|
|
117 | // right now, there are only ever two of them: |
|
|
118 | // the inventory and the floor/open container |
|
|
119 | //TODO: unused as of yet |
|
|
120 | struct client_container : vector< refitem, slice_allocator<refitem> > |
|
|
121 | { |
|
|
122 | client *ns; |
|
|
123 | enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type; |
|
|
124 | |
|
|
125 | bool item_changed; // one of the items in here possibly changed |
|
|
126 | |
|
|
127 | // for mapspace and container |
|
|
128 | int x, y; |
|
|
129 | maptile *map; |
|
|
130 | |
|
|
131 | // for container |
|
|
132 | object *env; |
|
|
133 | |
|
|
134 | client_container (client *ns) |
|
|
135 | : ns (ns), type (CC_NONE) { } |
|
|
136 | |
|
|
137 | tag_t tag () const; |
|
|
138 | |
|
|
139 | inline iterator merge_item (iterator i, object *op); |
|
|
140 | |
|
|
141 | void clear (); |
|
|
142 | void update (); |
|
|
143 | |
|
|
144 | void set_mapspace (maptile *map, int x, int y); |
|
|
145 | void set_container (object *env); |
|
|
146 | }; |
149 | }; |
147 | |
150 | |
148 | /* 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. */ |
149 | #define MAX_PASSWORD_FAILURES 5 |
152 | #define MAX_PASSWORD_FAILURES 5 |
150 | |
153 | |
… | |
… | |
152 | struct client : zero_initialised, attachable |
155 | struct client : zero_initialised, attachable |
153 | { |
156 | { |
154 | int ACC (RW, fd); |
157 | int ACC (RW, fd); |
155 | unsigned int inbuf_len; // number of bytes valid in inbuf |
158 | unsigned int inbuf_len; // number of bytes valid in inbuf |
156 | statsinfo stats; |
159 | statsinfo stats; |
157 | int ACC (RO, active); |
160 | object_vector_index ACC (RO, active); |
|
|
161 | player_ptr ACC (RO, pl); |
158 | |
162 | |
159 | /* The following is the setup for a ring buffer for storing output |
163 | /* The following is the setup for a ring buffer for storing output |
160 | * data that the OS can't handle right away. |
164 | * data that the OS can't handle right away. |
161 | */ |
165 | */ |
162 | struct |
166 | struct |
… | |
… | |
192 | bool ACC (RW, sent_scroll); |
196 | bool ACC (RW, sent_scroll); |
193 | bool ACC (RW, sound); /* does the client want sound */ |
197 | bool ACC (RW, sound); /* does the client want sound */ |
194 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
198 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
195 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
199 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
196 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
200 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
197 | bool ACC (RW, extcmd); // call into extensions/plugins |
201 | uint8_t ACC (RW, extcmd); // call into extensions/plugins |
198 | bool ACC (RW, extmap); // extend map comamnd with extra data |
202 | bool ACC (RW, extmap); // extend map comamnd with extra data |
199 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
203 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
200 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
204 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
201 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
205 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
202 | bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
206 | uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
203 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
207 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
204 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
208 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
205 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
209 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
206 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
210 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
207 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
211 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
… | |
… | |
224 | region *ACC (RW, current_region); // CF+ last/current player region |
228 | region *ACC (RW, current_region); // CF+ last/current player region |
225 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
229 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
226 | shstr ACC (RW, version); // CF+ client name/version |
230 | shstr ACC (RW, version); // CF+ client name/version |
227 | uint8 ACC (RW, faceset); // CF+ selected faceset |
231 | uint8 ACC (RW, faceset); // CF+ selected faceset |
228 | |
232 | |
229 | player_ptr ACC (RO, pl); |
233 | tstamp ACC (RW, last_send); // last data send on socket. |
230 | |
|
|
231 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
|
|
232 | |
234 | |
233 | int ACC (RW, rate_avail); // current rate balance |
235 | int ACC (RW, rate_avail); // current rate balance |
234 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
236 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
235 | faceidx ACC (RW, scrub_idx); // which face to send next |
237 | faceidx ACC (RW, scrub_idx); // which face to send next |
236 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
238 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
237 | |
239 | |
238 | faceidx partial_face; |
240 | struct tcp_info tcpi; |
239 | uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face |
241 | tstamp next_rate_adjust; |
240 | std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client |
|
|
241 | |
242 | |
|
|
243 | unordered_vector<char *> mapinfo_queue; |
|
|
244 | void mapinfo_queue_clear (); |
|
|
245 | void mapinfo_queue_run (); |
|
|
246 | bool mapinfo_try (char *buf); |
|
|
247 | |
|
|
248 | struct ixsend { |
|
|
249 | int16_t pri; // unused |
|
|
250 | faceidx idx; |
|
|
251 | uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
|
|
252 | }; |
|
|
253 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
|
|
254 | |
242 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
255 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
243 | MTH void flush_fx (); // send fx if required |
256 | MTH void flush_fx (); // send fx if required |
244 | |
257 | |
245 | void do_destroy (); |
258 | void do_destroy (); |
246 | void gather_callbacks (AV *&callbacks, event_type event) const; |
259 | void gather_callbacks (AV *&callbacks, event_type event) const; |
247 | |
260 | |
248 | iow socket_ev; void socket_cb (iow &w, int got); |
261 | iow socket_ev; void socket_cb (iow &w, int revents); |
249 | iw cmd_ev; void cmd_cb (iw &w); |
|
|
250 | client_container cc_inv, cc_other; |
|
|
251 | |
262 | |
252 | std::deque< command, slice_allocator<command> > cmd_queue; |
263 | std::deque< command, slice_allocator<command> > cmd_queue; |
253 | |
264 | |
254 | // large structures at the end please |
265 | // large structures at the end please |
255 | struct Map lastmap; |
266 | struct Map lastmap; |
256 | std::bitset<MAXANIMNUM> anims_sent; |
267 | std::bitset<MAXANIMNUM> anims_sent; |
257 | std::bitset<MAX_FACES> faces_sent; |
268 | std::bitset<MAX_FACES> faces_sent; |
|
|
269 | std::bitset<FT_NUM> fx_want; |
258 | |
270 | |
259 | // if we get an incomplete packet, this is used to hold the data. |
271 | // if we get an incomplete packet, this is used to hold the data. |
260 | // we add 2 byte for the header, one for the trailing 0 byte |
272 | // we add 2 byte for the header, one for the trailing 0 byte |
261 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
273 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
262 | |
274 | |
… | |
… | |
294 | void send_packet (const char *buf, int len); |
306 | void send_packet (const char *buf, int len); |
295 | void send_packet_printf (const char *format, ...); |
307 | void send_packet_printf (const char *format, ...); |
296 | void send_packet (packet &sl); |
308 | void send_packet (packet &sl); |
297 | |
309 | |
298 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
310 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
|
|
311 | |
299 | MTH void send_face (faceidx facenum); |
312 | MTH void send_face (faceidx facenum, int pri = 0); |
300 | MTH void send_image (faceidx facenum); |
313 | MTH void send_image (faceidx facenum); |
301 | MTH void send_faces (object *ob); |
314 | MTH void send_faces (object *ob); |
302 | MTH void send_animation (short anim_num); |
315 | MTH void send_animation (short anim_num); |
303 | MTH void send_msg (int color, const char *type, const char *msg); |
316 | void send_msg (int color, const char *type, const char *msg); |
304 | |
317 | |
|
|
318 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
305 | // called when something under the player changes |
319 | // called when something under the player changes |
306 | MTH void floorbox_update () { update_look = 1; } |
320 | MTH void floorbox_update () { update_look = 1; } |
307 | // called when the player has been moved |
321 | // called when the player has been moved |
308 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
322 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
309 | |
323 | |
310 | MTH void tick (); // called every server tick to do housekeeping etc. |
324 | MTH void tick (); // called every server tick to do housekeeping etc. |
311 | |
325 | |
312 | MTH static client *create (int fd, const char *peername); |
326 | MTH static client *create (int fd, const char *peername); |
|
|
327 | MTH static void clock (); |
|
|
328 | MTH static void flush_sockets (); |
313 | |
329 | |
314 | protected: |
330 | protected: |
315 | client (int fd, const char *from_ip); |
331 | client (int fd, const char *from_ip); |
316 | ~client (); |
332 | ~client (); |
317 | }; |
333 | }; |
|
|
334 | |
|
|
335 | #if FOR_PERL |
|
|
336 | ACC (RW, tcpi.tcpi_state); |
|
|
337 | ACC (RW, tcpi.tcpi_ca_state); |
|
|
338 | ACC (RW, tcpi.tcpi_retransmits); |
|
|
339 | ACC (RW, tcpi.tcpi_probes); |
|
|
340 | ACC (RW, tcpi.tcpi_backoff); |
|
|
341 | ACC (RW, tcpi.tcpi_options); |
|
|
342 | ACC (RO, tcpi.tcpi_snd_wscale); |
|
|
343 | ACC (RO, tcpi.tcpi_rcv_wscale); |
|
|
344 | ACC (RW, tcpi.tcpi_rto); |
|
|
345 | ACC (RW, tcpi.tcpi_ato); |
|
|
346 | ACC (RW, tcpi.tcpi_snd_mss); |
|
|
347 | ACC (RW, tcpi.tcpi_rcv_mss); |
|
|
348 | ACC (RW, tcpi.tcpi_unacked); |
|
|
349 | ACC (RW, tcpi.tcpi_sacked); |
|
|
350 | ACC (RW, tcpi.tcpi_lost); |
|
|
351 | ACC (RW, tcpi.tcpi_retrans); |
|
|
352 | ACC (RW, tcpi.tcpi_fackets); |
|
|
353 | ACC (RW, tcpi.tcpi_last_data_sent); |
|
|
354 | ACC (RW, tcpi.tcpi_last_ack_sent); |
|
|
355 | ACC (RW, tcpi.tcpi_last_data_recv); |
|
|
356 | ACC (RW, tcpi.tcpi_last_ack_recv); |
|
|
357 | ACC (RW, tcpi.tcpi_pmtu); |
|
|
358 | ACC (RW, tcpi.tcpi_rcv_ssthresh); |
|
|
359 | ACC (RW, tcpi.tcpi_rtt); |
|
|
360 | ACC (RW, tcpi.tcpi_rttvar); |
|
|
361 | ACC (RW, tcpi.tcpi_snd_ssthresh); |
|
|
362 | ACC (RW, tcpi.tcpi_snd_cwnd); |
|
|
363 | ACC (RW, tcpi.tcpi_advmss); |
|
|
364 | ACC (RW, tcpi.tcpi_reordering); |
|
|
365 | #endif |
318 | |
366 | |
319 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
367 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
320 | ( ((__type)>0) &&\ |
368 | ( ((__type)>0) &&\ |
321 | ((__sockPtr)->has_readable_type) && \ |
369 | ((__sockPtr)->has_readable_type) && \ |
322 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
370 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
… | |
… | |
351 | #define PNG_FACE_INDEX 0 |
399 | #define PNG_FACE_INDEX 0 |
352 | |
400 | |
353 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
401 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
354 | #define VERSION_SC 1026 |
402 | #define VERSION_SC 1026 |
355 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
403 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
356 | #define VERSION_INFO "Crossfire+ Server" |
404 | #define VERSION_INFO "Deliantra Server" |
357 | |
405 | |
358 | typedef object_vector<client, &client::active> sockvec; |
406 | typedef object_vector<client, &client::active> sockvec; |
359 | |
407 | |
360 | extern sockvec clients; |
408 | extern sockvec clients; |
361 | |
409 | |
362 | #define for_all_clients(var) \ |
410 | #define for_all_clients(var) \ |
363 | for (int _i = 0; _i < clients.size (); ++_i) \ |
411 | for (int _i = 0; _i < clients.size (); ++_i) \ |
364 | declvar (client *, var, clients [_i]) |
412 | statementvar (client *, var, clients [_i]) |
365 | |
413 | |
366 | #endif |
414 | #endif |
367 | |
415 | |