1 | /* |
1 | /* |
2 | CrossFire, A Multiplayer game for the X Window System |
2 | * CrossFire, A Multiplayer game for the X Window System |
3 | |
3 | * |
|
|
4 | * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
4 | Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
5 | * Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
5 | Copyright (C) 1992 Frank Tore Johansen |
6 | * Copyright (C) 1992 Frank Tore Johansen |
6 | |
7 | * |
7 | This program is free software; you can redistribute it and/or modify |
8 | * This program is free software; you can redistribute it and/or modify |
8 | 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 |
9 | the Free Software Foundation; either version 2 of the License, or |
10 | * the Free Software Foundation; either version 2 of the License, or |
10 | (at your option) any later version. |
11 | * (at your option) any later version. |
11 | |
12 | * |
12 | 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, |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 | GNU General Public License for more details. |
16 | * GNU General Public License for more details. |
16 | |
17 | * |
17 | 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 |
18 | along with this program; if not, write to the Free Software |
19 | * along with this program; if not, write to the Free Software |
19 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
20 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
20 | |
21 | * |
21 | The author can be reached via e-mail to crossfire@schmorp.de |
22 | * The author can be reached via e-mail to crossfire@schmorp.de |
22 | */ |
23 | */ |
23 | |
24 | |
24 | #ifndef CLIENT_H |
25 | #ifndef CLIENT_H |
25 | #define CLIENT_H |
26 | #define CLIENT_H |
26 | |
27 | |
27 | #include <deque> |
28 | #include <deque> |
… | |
… | |
32 | #define FLOORBOX_PAGESIZE 50 |
33 | #define FLOORBOX_PAGESIZE 50 |
33 | |
34 | |
34 | struct MapCell |
35 | struct MapCell |
35 | { |
36 | { |
36 | UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
37 | UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
37 | int count; /* This is really darkness in the map1 command */ |
38 | int count; /* This is really darkness in the map1 command */ |
38 | uint16 faces[MAP_LAYERS]; |
39 | faceidx faces[MAP_LAYERS]; |
39 | uint16 smooth[MAP_LAYERS]; |
|
|
40 | unsigned char stat_hp; // health of something in this space, or 0 |
40 | unsigned char stat_hp; // health of something in this space, or 0 |
41 | unsigned char flags; |
41 | unsigned char flags; |
|
|
42 | uint8_t smooth[MAP_LAYERS]; |
42 | }; |
43 | }; |
43 | |
44 | |
44 | /* This basically defines the largest size an |
|
|
45 | * archetype may be - it is used for allocation of |
|
|
46 | * some structures, as well as determining how far |
|
|
47 | * we should look for the heads of big images. |
|
|
48 | */ |
|
|
49 | #define MAX_HEAD_OFFSET 8 |
|
|
50 | |
|
|
51 | #define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) |
45 | #define MAX_CLIENT_X MAP_CLIENT_X |
52 | #define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) |
46 | #define MAX_CLIENT_Y MAP_CLIENT_Y |
53 | |
47 | |
54 | struct Map |
48 | struct Map |
55 | { |
49 | { |
56 | struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
50 | struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
57 | }; |
51 | }; |
58 | |
52 | |
59 | /* True max is 16383 given current map compaction method */ |
53 | /* True max is 16383 given current map compaction method */ |
60 | # define MAXANIMNUM 2000 |
54 | #define MAXANIMNUM 10000 |
61 | |
55 | |
62 | struct statsinfo |
56 | struct statsinfo |
63 | { |
57 | { |
64 | char *range, *title; |
58 | char *range, *title; |
65 | }; |
59 | }; |
… | |
… | |
77 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
71 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
78 | |
72 | |
79 | /* The following is the setup for a ring buffer for storing output |
73 | /* The following is the setup for a ring buffer for storing output |
80 | * data that the OS can't handle right away. |
74 | * data that the OS can't handle right away. |
81 | */ |
75 | */ |
82 | |
|
|
83 | struct Buffer |
76 | struct Buffer |
84 | { |
77 | { |
85 | char data[SOCKETBUFSIZE]; |
78 | char data[SOCKETBUFSIZE]; |
86 | int start; |
79 | int start; |
87 | int len; |
80 | int len; |
… | |
… | |
92 | ST_DEAD, // socket is dead |
85 | ST_DEAD, // socket is dead |
93 | ST_SETUP, // initial handshake / setup / login |
86 | ST_SETUP, // initial handshake / setup / login |
94 | ST_PLAYING, // logged in an playing |
87 | ST_PLAYING, // logged in an playing |
95 | ST_CUSTOM, // waiting for custom reply |
88 | ST_CUSTOM, // waiting for custom reply |
96 | |
89 | |
97 | ST_PLAY_AGAIN, |
|
|
98 | ST_ROLL_STAT, |
|
|
99 | ST_CHANGE_CLASS, |
90 | ST_CHANGE_CLASS, |
100 | ST_CONFIRM_QUIT, |
|
|
101 | ST_CONFIGURE, |
|
|
102 | ST_GET_NAME, |
|
|
103 | ST_GET_PASSWORD, |
|
|
104 | ST_CONFIRM_PASSWORD, |
|
|
105 | ST_GET_PARTY_PASSWORD, |
91 | ST_GET_PARTY_PASSWORD, |
106 | }; |
92 | }; |
107 | |
93 | |
108 | // a handler for a specific type of packet |
94 | // a handler for a specific type of packet |
109 | enum { |
95 | enum { |
110 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
96 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
111 | PF_PLAYING = 0x02, // must be in playing state |
97 | PF_PLAYING = 0x02, // must be in playing state |
|
|
98 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
|
|
99 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
112 | }; |
100 | }; |
113 | |
101 | |
114 | struct packet_type |
102 | struct packet_type |
115 | { |
103 | { |
116 | const char *name; |
104 | const char *name; |
… | |
… | |
169 | }; |
157 | }; |
170 | |
158 | |
171 | /* how many times we are allowed to give the wrong password before being kicked. */ |
159 | /* how many times we are allowed to give the wrong password before being kicked. */ |
172 | #define MAX_PASSWORD_FAILURES 5 |
160 | #define MAX_PASSWORD_FAILURES 5 |
173 | |
161 | |
174 | ACC_CLASS (client) // should become player when newsocket is a baseclass of player |
162 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
175 | struct client : zero_initialised, attachable<client> |
163 | struct client : zero_initialised, attachable |
176 | { |
164 | { |
177 | int ACC (RW, fd); |
165 | int ACC (RW, fd); |
178 | unsigned int inbuf_len; // number of bytes valid in inbuf |
166 | unsigned int inbuf_len; // number of bytes valid in inbuf |
179 | uint8 *faces_sent; // This is a bitmap on sent face status |
167 | statsinfo stats; |
180 | statsinfo stats; |
168 | int ACC (RO, active); |
181 | |
169 | |
182 | client_container cc_inv, cc_other; |
|
|
183 | Buffer outputbuffer; |
170 | Buffer outputbuffer; |
184 | |
171 | |
185 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
172 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
186 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
173 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
187 | uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ |
|
|
188 | |
174 | |
|
|
175 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
|
|
176 | uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */ |
|
|
177 | float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */ |
|
|
178 | sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */ |
|
|
179 | sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */ |
|
|
180 | uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */ |
|
|
181 | uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
|
|
182 | uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
|
|
183 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
|
|
184 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
|
|
185 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
|
|
186 | sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
|
|
187 | |
|
|
188 | bool ACC (RW, afk); /* player is afk */ |
189 | bool ACC (RW, facecache); /* If true, client is caching images */ |
189 | bool ACC (RW, facecache); /* If true, client is caching images */ |
190 | bool ACC (RW, sent_scroll); |
190 | bool ACC (RW, sent_scroll); |
191 | bool ACC (RW, sound); /* does the client want sound */ |
191 | bool ACC (RW, sound); /* does the client want sound */ |
192 | bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */ |
|
|
193 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
192 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
194 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
193 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
195 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
194 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
196 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
195 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
197 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
196 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
198 | bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ |
197 | bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ |
|
|
198 | bool ACC (RW, force_face0); /* CF+ client workaround for buggy checksum calculation in gcfclient */ |
|
|
199 | bool ACC (RW, force_bad_checksum); /* CF+ client workaround for buggy checksum calculation in gcfclient */ |
199 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
200 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
200 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
201 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
201 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
202 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
202 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
203 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
203 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
204 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
… | |
… | |
211 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
212 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
212 | enum MapMode mapmode; /* Type of map commands the client wants. */ |
213 | enum MapMode mapmode; /* Type of map commands the client wants. */ |
213 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
214 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
214 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
215 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
215 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
216 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
216 | uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ |
|
|
217 | |
217 | |
218 | maptile *ACC (RW, current_map); // CF+ last/current player map |
218 | maptile *ACC (RW, current_map); // CF+ last/current player map |
|
|
219 | region *ACC (RW, current_region); // CF+ last/current player region |
219 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
220 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
220 | char ACC (RW, version)[64]; // CF+ client name/version |
221 | char ACC (RW, version)[64]; // CF+ client name/version |
|
|
222 | uint8 ACC (RW, faceset); // CF+ selected faceset |
221 | |
223 | |
222 | player *ACC (RO, pl);//TODO should not be here, preferably |
224 | player_ptr ACC (RO, pl); |
223 | |
225 | |
224 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
226 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
225 | |
227 | |
226 | client (int fd, const char *from_ip); |
228 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
227 | ~client (); |
229 | std::vector<faceidx> askface; // which faces have been requested by the client |
|
|
230 | |
228 | void destroy (); |
231 | void do_destroy (); |
229 | bool destroyed () const { return state == ST_DEAD; } |
232 | void gather_callbacks (AV *&callbacks, event_type event) const; |
230 | |
233 | |
|
|
234 | iow socket_ev; void socket_cb (iow &w, int got); |
231 | iw cmd_ev; void cmd_cb (iw &w); |
235 | iw cmd_ev; void cmd_cb (iw &w); |
232 | iow socket_ev; void socket_cb (iow &w, int got); |
236 | client_container cc_inv, cc_other; |
233 | |
237 | |
234 | std::deque< command, slice_allocator<command> > cmd_queue; |
238 | std::deque< command, slice_allocator<command> > cmd_queue; |
235 | |
239 | |
236 | // large structures at the end please |
240 | // large structures at the end please |
237 | struct Map lastmap; |
241 | struct Map lastmap; |
238 | std::bitset<MAXANIMNUM> anims_sent; |
242 | std::bitset<MAXANIMNUM> anims_sent; |
|
|
243 | std::bitset<MAX_FACES> faces_sent; |
|
|
244 | |
239 | // if we get an incomplete packet, this is used to hold the data. |
245 | // if we get an incomplete packet, this is used to hold the data. |
240 | // we add 2 byte for the header, one for the trailing 0 byte |
246 | // we add 2 byte for the header, one for the trailing 0 byte |
241 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
247 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
242 | |
248 | |
243 | bool may_execute (const packet_type *pkt) const; |
249 | bool may_execute (const packet_type *pkt) const; |
244 | void execute (const packet_type *pkt, char *data, int datalen); |
250 | void execute (const packet_type *pkt, char *data, int datalen); |
245 | |
251 | |
246 | void queue_command (packet_type *handler, char *data, int datalen); |
252 | void queue_command (packet_type *handler, char *data, int datalen); |
247 | bool handle_command (); |
253 | MTH bool handle_command (); |
248 | // resets movement state |
254 | // resets movement state |
249 | void reset_state (); |
255 | MTH void reset_state (); |
|
|
256 | // resets variable data used to send stat diffs |
|
|
257 | MTH void reset_stats (); |
250 | |
258 | |
251 | bool handle_packet (); |
259 | MTH bool handle_packet (); |
252 | int next_packet (); // returns length of packet or 0 |
260 | int next_packet (); // returns length of packet or 0 |
253 | void skip_packet (int len); // we have processed the packet, skip it |
261 | void skip_packet (int len); // we have processed the packet, skip it |
254 | |
262 | |
255 | void flush (); |
263 | MTH void flush (); |
256 | void write_outputbuffer (); |
264 | MTH void write_outputbuffer (); |
|
|
265 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
257 | void send (void *buf_, int len); |
266 | void send (void *buf_, int len); |
258 | |
267 | |
259 | void send_packet (const char *buf); |
268 | void send_packet (const char *buf); |
260 | void send_packet (const char *buf, int len); |
269 | void send_packet (const char *buf, int len); |
261 | void send_packet_printf (const char *format, ...); |
270 | void send_packet_printf (const char *format, ...); |
262 | void send_packet (packet &sl); |
271 | void send_packet (packet &sl); |
263 | |
272 | |
|
|
273 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
|
|
274 | MTH void send_face (faceidx facenum); |
|
|
275 | MTH void send_image (faceidx facenum); |
|
|
276 | MTH void send_faces (object *ob); |
|
|
277 | MTH void send_animation (short anim_num); |
|
|
278 | |
264 | // called when something under the player changes |
279 | // called when something under the player changes |
265 | void floorbox_update () { update_look = 1; } |
280 | MTH void floorbox_update () { update_look = 1; } |
266 | // called when the player has been moved |
281 | // called when the player has been moved |
267 | void floorbox_reset () { look_position = 0; floorbox_update (); } |
282 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
268 | |
283 | |
269 | static client *create (int fd, const char *peername); |
284 | MTH static client *create (int fd, const char *peername); |
|
|
285 | |
|
|
286 | protected: |
|
|
287 | client (int fd, const char *from_ip); |
|
|
288 | ~client (); |
270 | }; |
289 | }; |
271 | |
290 | |
272 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
291 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
273 | ( ((__type)>0) &&\ |
292 | ( ((__type)>0) &&\ |
274 | ((__sockPtr)->has_readable_type) && \ |
293 | ((__sockPtr)->has_readable_type) && \ |
275 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
294 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
276 | |
|
|
277 | /* Bitmask for the faces_sent[] array - what |
|
|
278 | * portion of the face have we sent? |
|
|
279 | */ |
|
|
280 | #define NS_FACESENT_FACE 0x1 |
|
|
281 | #define NS_FACESENT_SMOOTH 0x2 |
|
|
282 | |
295 | |
283 | /* Constants in the form EMI_ is for extended map infos. |
296 | /* Constants in the form EMI_ is for extended map infos. |
284 | * Even if the client select the additionnal infos it wants |
297 | * Even if the client select the additionnal infos it wants |
285 | * on the map, there may exist cases where this whole info |
298 | * on the map, there may exist cases where this whole info |
286 | * is not given in one buch but in separate bunches. This |
299 | * is not given in one buch but in separate bunches. This |
… | |
… | |
308 | |
321 | |
309 | #define FACE_TYPES 1 |
322 | #define FACE_TYPES 1 |
310 | #define PNG_FACE_INDEX 0 |
323 | #define PNG_FACE_INDEX 0 |
311 | |
324 | |
312 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
325 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
313 | #define VERSION_SC 1027 |
326 | #define VERSION_SC 1026 |
|
|
327 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
314 | #define VERSION_INFO "Crossfire+ Server" |
328 | #define VERSION_INFO "Crossfire+ Server" |
315 | |
329 | |
316 | typedef unordered_vector<client *> sockvec; |
330 | typedef object_vector<client, &client::active> sockvec; |
317 | |
331 | |
318 | extern sockvec clients; |
332 | extern sockvec clients; |
319 | extern int nrofpixmaps; //TODO: hrmpf, should go |
333 | |
|
|
334 | #define for_all_clients(var) \ |
|
|
335 | for (int _i = 0; _i < clients.size (); ++_i) \ |
|
|
336 | declvar (client *, var, clients [_i]) |
320 | |
337 | |
321 | #endif |
338 | #endif |
322 | |
339 | |