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> |
… | |
… | |
77 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
78 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
78 | |
79 | |
79 | /* The following is the setup for a ring buffer for storing output |
80 | /* The following is the setup for a ring buffer for storing output |
80 | * data that the OS can't handle right away. |
81 | * data that the OS can't handle right away. |
81 | */ |
82 | */ |
82 | |
|
|
83 | struct Buffer |
83 | struct Buffer |
84 | { |
84 | { |
85 | char data[SOCKETBUFSIZE]; |
85 | char data[SOCKETBUFSIZE]; |
86 | int start; |
86 | int start; |
87 | int len; |
87 | int len; |
… | |
… | |
92 | ST_DEAD, // socket is dead |
92 | ST_DEAD, // socket is dead |
93 | ST_SETUP, // initial handshake / setup / login |
93 | ST_SETUP, // initial handshake / setup / login |
94 | ST_PLAYING, // logged in an playing |
94 | ST_PLAYING, // logged in an playing |
95 | ST_CUSTOM, // waiting for custom reply |
95 | ST_CUSTOM, // waiting for custom reply |
96 | |
96 | |
97 | ST_PLAY_AGAIN, |
|
|
98 | ST_ROLL_STAT, |
|
|
99 | ST_CHANGE_CLASS, |
97 | 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, |
98 | ST_GET_PARTY_PASSWORD, |
106 | }; |
99 | }; |
107 | |
100 | |
108 | // a handler for a specific type of packet |
101 | // a handler for a specific type of packet |
109 | enum { |
102 | enum { |
110 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
103 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
111 | PF_PLAYING = 0x02, // must be in playing state |
104 | PF_PLAYING = 0x02, // must be in playing state |
|
|
105 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
|
|
106 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
112 | }; |
107 | }; |
113 | |
108 | |
114 | struct packet_type |
109 | struct packet_type |
115 | { |
110 | { |
116 | const char *name; |
111 | const char *name; |
… | |
… | |
169 | }; |
164 | }; |
170 | |
165 | |
171 | /* how many times we are allowed to give the wrong password before being kicked. */ |
166 | /* how many times we are allowed to give the wrong password before being kicked. */ |
172 | #define MAX_PASSWORD_FAILURES 5 |
167 | #define MAX_PASSWORD_FAILURES 5 |
173 | |
168 | |
174 | ACC_CLASS (client) // should become player when newsocket is a baseclass of player |
169 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
175 | struct client : zero_initialised, attachable<client> |
170 | struct client : zero_initialised, attachable |
176 | { |
171 | { |
177 | int ACC (RW, fd); |
172 | int ACC (RW, fd); |
178 | unsigned int inbuf_len; // number of bytes valid in inbuf |
173 | unsigned int inbuf_len; // number of bytes valid in inbuf |
179 | uint8 *faces_sent; // This is a bitmap on sent face status |
174 | uint8 *faces_sent; // This is a bitmap on sent face status |
180 | statsinfo stats; |
175 | statsinfo stats; |
|
|
176 | int ACC (RO, active); |
181 | |
177 | |
182 | client_container cc_inv, cc_other; |
178 | client_container cc_inv, cc_other; |
183 | Buffer outputbuffer; |
179 | Buffer outputbuffer; |
184 | |
180 | |
185 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
181 | 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 */ |
182 | 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 | |
183 | |
|
|
184 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
|
|
185 | uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */ |
|
|
186 | float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */ |
|
|
187 | sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */ |
|
|
188 | sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */ |
|
|
189 | uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */ |
|
|
190 | uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
|
|
191 | uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
|
|
192 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
|
|
193 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
|
|
194 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
|
|
195 | sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
|
|
196 | |
|
|
197 | bool ACC (RW, afk); /* player is afk */ |
189 | bool ACC (RW, facecache); /* If true, client is caching images */ |
198 | bool ACC (RW, facecache); /* If true, client is caching images */ |
190 | bool ACC (RW, sent_scroll); |
199 | bool ACC (RW, sent_scroll); |
191 | bool ACC (RW, sound); /* does the client want sound */ |
200 | 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 */ |
201 | 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 */ |
202 | 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 */ |
203 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
196 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
204 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
197 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
205 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
… | |
… | |
217 | |
225 | |
218 | maptile *ACC (RW, current_map); // CF+ last/current player map |
226 | maptile *ACC (RW, current_map); // CF+ last/current player map |
219 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
227 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
220 | char ACC (RW, version)[64]; // CF+ client name/version |
228 | char ACC (RW, version)[64]; // CF+ client name/version |
221 | |
229 | |
222 | player *ACC (RO, pl);//TODO should not be here, preferably |
230 | player_ptr ACC (RO, pl); |
223 | |
231 | |
224 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
232 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
225 | |
233 | |
226 | client (int fd, const char *from_ip); |
|
|
227 | ~client (); |
|
|
228 | void destroy (); |
234 | void do_destroy (); |
229 | bool destroyed () const { return state == ST_DEAD; } |
235 | void gather_callbacks (AV *&callbacks, event_type event) const; |
230 | |
236 | |
231 | iw cmd_ev; void cmd_cb (iw &w); |
237 | iw cmd_ev; void cmd_cb (iw &w); |
232 | iow socket_ev; void socket_cb (iow &w, int got); |
238 | iow socket_ev; void socket_cb (iow &w, int got); |
233 | |
239 | |
234 | std::deque< command, slice_allocator<command> > cmd_queue; |
240 | std::deque< command, slice_allocator<command> > cmd_queue; |
… | |
… | |
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 (); |
257 | void send (void *buf_, int len); |
265 | void send (void *buf_, int len); |
258 | |
266 | |
259 | void send_packet (const char *buf); |
267 | void send_packet (const char *buf); |
260 | void send_packet (const char *buf, int len); |
268 | void send_packet (const char *buf, int len); |
261 | void send_packet_printf (const char *format, ...); |
269 | void send_packet_printf (const char *format, ...); |
262 | void send_packet (packet &sl); |
270 | void send_packet (packet &sl); |
263 | |
271 | |
264 | // called when something under the player changes |
272 | // called when something under the player changes |
265 | void floorbox_update () { update_look = 1; } |
273 | MTH void floorbox_update () { update_look = 1; } |
266 | // called when the player has been moved |
274 | // called when the player has been moved |
267 | void floorbox_reset () { look_position = 0; floorbox_update (); } |
275 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
268 | |
276 | |
269 | static client *create (int fd, const char *peername); |
277 | MTH static client *create (int fd, const char *peername); |
|
|
278 | |
|
|
279 | protected: |
|
|
280 | client (int fd, const char *from_ip); |
|
|
281 | ~client (); |
270 | }; |
282 | }; |
271 | |
283 | |
272 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
284 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
273 | ( ((__type)>0) &&\ |
285 | ( ((__type)>0) &&\ |
274 | ((__sockPtr)->has_readable_type) && \ |
286 | ((__sockPtr)->has_readable_type) && \ |
… | |
… | |
311 | |
323 | |
312 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
324 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
313 | #define VERSION_SC 1027 |
325 | #define VERSION_SC 1027 |
314 | #define VERSION_INFO "Crossfire+ Server" |
326 | #define VERSION_INFO "Crossfire+ Server" |
315 | |
327 | |
316 | typedef unordered_vector<client *> sockvec; |
328 | typedef object_vector<client, &client::active> sockvec; |
317 | |
329 | |
318 | extern sockvec clients; |
330 | extern sockvec clients; |
|
|
331 | |
|
|
332 | #define for_all_clients(var) \ |
|
|
333 | for (int _i = 0; _i < clients.size (); ++_i) \ |
|
|
334 | declvar (client *, var, clients [_i]) |
|
|
335 | |
319 | extern int nrofpixmaps; //TODO: hrmpf, should go |
336 | extern int nrofpixmaps; //TODO: hrmpf, should go |
320 | |
337 | |
321 | #endif |
338 | #endif |
322 | |
339 | |