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) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
5 | Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
5 | * Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
6 | Copyright (C) 1992 Frank Tore Johansen |
6 | * Copyright (C) 1992 Frank Tore Johansen |
7 | |
7 | * |
8 | 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 |
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 2 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, write to the Free Software |
20 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
20 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
21 | |
21 | * |
22 | 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 |
23 | */ |
23 | */ |
24 | |
24 | |
25 | #ifndef CLIENT_H |
25 | #ifndef CLIENT_H |
26 | #define CLIENT_H |
26 | #define CLIENT_H |
27 | |
27 | |
28 | #include <deque> |
28 | #include <deque> |
… | |
… | |
33 | #define FLOORBOX_PAGESIZE 50 |
33 | #define FLOORBOX_PAGESIZE 50 |
34 | |
34 | |
35 | struct MapCell |
35 | struct MapCell |
36 | { |
36 | { |
37 | 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 |
38 | int count; /* This is really darkness in the map1 command */ |
38 | int count; /* This is really darkness in the map1 command */ |
39 | uint16 faces[MAP_LAYERS]; |
39 | faceidx faces[MAP_LAYERS]; |
40 | uint16 smooth[MAP_LAYERS]; |
|
|
41 | 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 |
42 | unsigned char flags; |
41 | unsigned char flags; |
|
|
42 | uint8_t smooth[MAP_LAYERS]; |
43 | }; |
43 | }; |
44 | |
44 | |
45 | /* This basically defines the largest size an |
|
|
46 | * archetype may be - it is used for allocation of |
|
|
47 | * some structures, as well as determining how far |
|
|
48 | * we should look for the heads of big images. |
|
|
49 | */ |
|
|
50 | #define MAX_HEAD_OFFSET 8 |
|
|
51 | |
|
|
52 | #define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) |
45 | #define MAX_CLIENT_X MAP_CLIENT_X |
53 | #define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) |
46 | #define MAX_CLIENT_Y MAP_CLIENT_Y |
54 | |
47 | |
55 | struct Map |
48 | struct Map |
56 | { |
49 | { |
57 | struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
50 | struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
58 | }; |
51 | }; |
59 | |
52 | |
60 | /* True max is 16383 given current map compaction method */ |
53 | /* True max is 16383 given current map compaction method */ |
61 | # define MAXANIMNUM 2000 |
54 | #define MAXANIMNUM 10000 |
62 | |
55 | |
63 | struct statsinfo |
56 | struct statsinfo |
64 | { |
57 | { |
65 | char *range, *title; |
58 | char *range, *title; |
66 | }; |
59 | }; |
… | |
… | |
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_CONFIRM_QUIT, |
|
|
98 | ST_CHANGE_CLASS, |
90 | ST_CHANGE_CLASS, |
99 | ST_GET_PARTY_PASSWORD, |
91 | ST_GET_PARTY_PASSWORD, |
100 | }; |
92 | }; |
101 | |
93 | |
102 | // a handler for a specific type of packet |
94 | // a handler for a specific type of packet |
103 | enum { |
95 | enum { |
104 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
96 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
105 | 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 |
106 | }; |
100 | }; |
107 | |
101 | |
108 | struct packet_type |
102 | struct packet_type |
109 | { |
103 | { |
110 | const char *name; |
104 | const char *name; |
… | |
… | |
168 | INTERFACE_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 |
169 | struct client : zero_initialised, attachable |
163 | struct client : zero_initialised, attachable |
170 | { |
164 | { |
171 | int ACC (RW, fd); |
165 | int ACC (RW, fd); |
172 | unsigned int inbuf_len; // number of bytes valid in inbuf |
166 | unsigned int inbuf_len; // number of bytes valid in inbuf |
173 | uint8 *faces_sent; // This is a bitmap on sent face status |
|
|
174 | statsinfo stats; |
167 | statsinfo stats; |
|
|
168 | int ACC (RO, active); |
175 | |
169 | |
176 | client_container cc_inv, cc_other; |
|
|
177 | Buffer outputbuffer; |
170 | Buffer outputbuffer; |
178 | |
171 | |
179 | 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) */ |
180 | 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 */ |
181 | uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ |
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 */ |
182 | |
187 | |
183 | bool ACC (RW, afk); /* player is afk */ |
188 | bool ACC (RW, afk); /* player is afk */ |
184 | bool ACC (RW, facecache); /* If true, client is caching images */ |
189 | bool ACC (RW, facecache); /* If true, client is caching images */ |
185 | bool ACC (RW, sent_scroll); |
190 | bool ACC (RW, sent_scroll); |
186 | bool ACC (RW, sound); /* does the client want sound */ |
191 | bool ACC (RW, sound); /* does the client want sound */ |
187 | 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 */ |
188 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
193 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
189 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
194 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
190 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
195 | bool ACC (RW, extcmd); // call into extensions/plugins |
191 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
196 | bool ACC (RW, extmap); // extend map comamnd with extra data |
192 | bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ |
197 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
|
|
198 | bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient |
|
|
199 | bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient |
|
|
200 | bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload |
193 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
201 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
194 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
202 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
195 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
203 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
196 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
204 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
197 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
205 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
… | |
… | |
199 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
207 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
200 | /* Below are flags for extedend infos to pass to client |
208 | /* Below are flags for extedend infos to pass to client |
201 | * with S->C mapextended command */ |
209 | * with S->C mapextended command */ |
202 | bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
210 | bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
203 | |
211 | |
|
|
212 | bool ACC (RW, force_newmap); // force a newmap before next map update |
204 | uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
213 | uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
205 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
214 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
206 | enum MapMode mapmode; /* Type of map commands the client wants. */ |
215 | enum MapMode mapmode; /* Type of map commands the client wants. */ |
207 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
216 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
208 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
217 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
209 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
218 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
210 | uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ |
|
|
211 | |
219 | |
212 | maptile *ACC (RW, current_map); // CF+ last/current player map |
220 | maptile *ACC (RW, current_map); // CF+ last/current player map |
|
|
221 | region *ACC (RW, current_region); // CF+ last/current player region |
213 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
222 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
214 | char ACC (RW, version)[64]; // CF+ client name/version |
223 | char ACC (RW, version)[64]; // CF+ client name/version |
|
|
224 | uint8 ACC (RW, faceset); // CF+ selected faceset |
215 | |
225 | |
216 | player_ptr ACC (RO, pl); |
226 | player_ptr ACC (RO, pl); |
217 | |
227 | |
218 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
228 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
|
|
229 | |
|
|
230 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
|
|
231 | faceidx ACC (RW, scrub_idx); // which face to send next |
|
|
232 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
|
|
233 | std::vector<faceidx> askface; // which faces have been requested by the client |
219 | |
234 | |
220 | void do_destroy (); |
235 | void do_destroy (); |
221 | void gather_callbacks (AV *&callbacks, event_type event) const; |
236 | void gather_callbacks (AV *&callbacks, event_type event) const; |
222 | |
237 | |
|
|
238 | iow socket_ev; void socket_cb (iow &w, int got); |
223 | iw cmd_ev; void cmd_cb (iw &w); |
239 | iw cmd_ev; void cmd_cb (iw &w); |
224 | iow socket_ev; void socket_cb (iow &w, int got); |
240 | client_container cc_inv, cc_other; |
225 | |
241 | |
226 | std::deque< command, slice_allocator<command> > cmd_queue; |
242 | std::deque< command, slice_allocator<command> > cmd_queue; |
227 | |
243 | |
228 | // large structures at the end please |
244 | // large structures at the end please |
229 | struct Map lastmap; |
245 | struct Map lastmap; |
230 | std::bitset<MAXANIMNUM> anims_sent; |
246 | std::bitset<MAXANIMNUM> anims_sent; |
|
|
247 | std::bitset<MAX_FACES> faces_sent; |
|
|
248 | |
231 | // if we get an incomplete packet, this is used to hold the data. |
249 | // if we get an incomplete packet, this is used to hold the data. |
232 | // we add 2 byte for the header, one for the trailing 0 byte |
250 | // we add 2 byte for the header, one for the trailing 0 byte |
233 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
251 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
234 | |
252 | |
235 | bool may_execute (const packet_type *pkt) const; |
253 | bool may_execute (const packet_type *pkt) const; |
… | |
… | |
237 | |
255 | |
238 | void queue_command (packet_type *handler, char *data, int datalen); |
256 | void queue_command (packet_type *handler, char *data, int datalen); |
239 | MTH bool handle_command (); |
257 | MTH bool handle_command (); |
240 | // resets movement state |
258 | // resets movement state |
241 | MTH void reset_state (); |
259 | MTH void reset_state (); |
|
|
260 | // resets variable data used to send stat diffs |
|
|
261 | MTH void reset_stats (); |
242 | |
262 | |
243 | MTH bool handle_packet (); |
263 | MTH bool handle_packet (); |
244 | int next_packet (); // returns length of packet or 0 |
264 | int next_packet (); // returns length of packet or 0 |
245 | void skip_packet (int len); // we have processed the packet, skip it |
265 | void skip_packet (int len); // we have processed the packet, skip it |
246 | |
266 | |
247 | MTH void flush (); |
267 | MTH void flush (); |
248 | MTH void write_outputbuffer (); |
268 | MTH void write_outputbuffer (); |
|
|
269 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
249 | void send (void *buf_, int len); |
270 | void send (void *buf_, int len); |
250 | |
271 | |
251 | void send_packet (const char *buf); |
272 | void send_packet (const char *buf); |
252 | void send_packet (const char *buf, int len); |
273 | void send_packet (const char *buf, int len); |
253 | void send_packet_printf (const char *format, ...); |
274 | void send_packet_printf (const char *format, ...); |
254 | void send_packet (packet &sl); |
275 | void send_packet (packet &sl); |
255 | |
276 | |
|
|
277 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
|
|
278 | MTH void send_face (faceidx facenum); |
|
|
279 | MTH void send_image (faceidx facenum); |
|
|
280 | MTH void send_faces (object *ob); |
|
|
281 | MTH void send_animation (short anim_num); |
|
|
282 | |
256 | // called when something under the player changes |
283 | // called when something under the player changes |
257 | MTH void floorbox_update () { update_look = 1; } |
284 | MTH void floorbox_update () { update_look = 1; } |
258 | // called when the player has been moved |
285 | // called when the player has been moved |
259 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
286 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
260 | |
287 | |
|
|
288 | MTH void tick (); // called every server tick to do housekeeping etc. |
|
|
289 | |
261 | MTH static client *create (int fd, const char *peername); |
290 | MTH static client *create (int fd, const char *peername); |
262 | |
291 | |
263 | protected: |
292 | protected: |
264 | client (int fd, const char *from_ip); |
293 | client (int fd, const char *from_ip); |
265 | ~client (); |
294 | ~client (); |
… | |
… | |
267 | |
296 | |
268 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
297 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
269 | ( ((__type)>0) &&\ |
298 | ( ((__type)>0) &&\ |
270 | ((__sockPtr)->has_readable_type) && \ |
299 | ((__sockPtr)->has_readable_type) && \ |
271 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
300 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
272 | |
|
|
273 | /* Bitmask for the faces_sent[] array - what |
|
|
274 | * portion of the face have we sent? |
|
|
275 | */ |
|
|
276 | #define NS_FACESENT_FACE 0x1 |
|
|
277 | #define NS_FACESENT_SMOOTH 0x2 |
|
|
278 | |
301 | |
279 | /* Constants in the form EMI_ is for extended map infos. |
302 | /* Constants in the form EMI_ is for extended map infos. |
280 | * Even if the client select the additionnal infos it wants |
303 | * Even if the client select the additionnal infos it wants |
281 | * on the map, there may exist cases where this whole info |
304 | * on the map, there may exist cases where this whole info |
282 | * is not given in one buch but in separate bunches. This |
305 | * is not given in one buch but in separate bunches. This |
… | |
… | |
304 | |
327 | |
305 | #define FACE_TYPES 1 |
328 | #define FACE_TYPES 1 |
306 | #define PNG_FACE_INDEX 0 |
329 | #define PNG_FACE_INDEX 0 |
307 | |
330 | |
308 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
331 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
309 | #define VERSION_SC 1027 |
332 | #define VERSION_SC 1026 |
|
|
333 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
310 | #define VERSION_INFO "Crossfire+ Server" |
334 | #define VERSION_INFO "Crossfire+ Server" |
311 | |
335 | |
312 | typedef unordered_vector<client *> sockvec; |
336 | typedef object_vector<client, &client::active> sockvec; |
313 | |
337 | |
314 | extern sockvec clients; |
338 | extern sockvec clients; |
315 | extern int nrofpixmaps; //TODO: hrmpf, should go |
339 | |
|
|
340 | #define for_all_clients(var) \ |
|
|
341 | for (int _i = 0; _i < clients.size (); ++_i) \ |
|
|
342 | declvar (client *, var, clients [_i]) |
316 | |
343 | |
317 | #endif |
344 | #endif |
318 | |
345 | |