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> |
… | |
… | |
68 | * current state. we set up our on buffers for sending/receiving, so we can |
69 | * current state. we set up our on buffers for sending/receiving, so we can |
69 | * handle some higher level functions. fd is the actual file descriptor we |
70 | * handle some higher level functions. fd is the actual file descriptor we |
70 | * are using. |
71 | * are using. |
71 | */ |
72 | */ |
72 | |
73 | |
73 | enum Sock_Status { Ns_Add, Ns_Dead }; |
|
|
74 | |
|
|
75 | /* Only one map mode can actually be used, so lets make it a switch |
74 | /* Only one map mode can actually be used, so lets make it a switch |
76 | * instead of having a bunch of different fields that needed to |
75 | * instead of having a bunch of different fields that needed to |
77 | * get toggled. |
76 | * get toggled. |
78 | */ |
77 | */ |
79 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
78 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
80 | |
79 | |
81 | /* 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 |
82 | * data that the OS can't handle right away. |
81 | * data that the OS can't handle right away. |
83 | */ |
82 | */ |
84 | |
|
|
85 | struct Buffer |
83 | struct Buffer |
86 | { |
84 | { |
87 | char data[SOCKETBUFSIZE]; |
85 | char data[SOCKETBUFSIZE]; |
88 | int start; |
86 | int start; |
89 | int len; |
87 | int len; |
90 | }; |
88 | }; |
91 | |
89 | |
|
|
90 | // states the socket can be in |
|
|
91 | enum { |
|
|
92 | ST_DEAD, // socket is dead |
|
|
93 | ST_SETUP, // initial handshake / setup / login |
|
|
94 | ST_PLAYING, // logged in an playing |
|
|
95 | ST_CUSTOM, // waiting for custom reply |
|
|
96 | |
|
|
97 | ST_CHANGE_CLASS, |
|
|
98 | ST_GET_PARTY_PASSWORD, |
|
|
99 | }; |
|
|
100 | |
92 | // a handler for a specific type of packet |
101 | // a handler for a specific type of packet |
93 | enum { |
102 | enum { |
94 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
103 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
95 | 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 |
96 | }; |
107 | }; |
97 | |
108 | |
98 | struct packet_type |
109 | struct packet_type |
99 | { |
110 | { |
100 | const char *name; |
111 | const char *name; |
… | |
… | |
153 | }; |
164 | }; |
154 | |
165 | |
155 | /* 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. */ |
156 | #define MAX_PASSWORD_FAILURES 5 |
167 | #define MAX_PASSWORD_FAILURES 5 |
157 | |
168 | |
158 | 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 |
159 | struct client : zero_initialised, attachable_base |
170 | struct client : zero_initialised, attachable |
160 | { |
171 | { |
161 | enum Sock_Status status; |
|
|
162 | int ACC (RW, fd); |
172 | int ACC (RW, fd); |
163 | unsigned int inbuf_len; // number of bytes valid in inbuf |
173 | unsigned int inbuf_len; // number of bytes valid in inbuf |
164 | uint8 *faces_sent; // This is a bitmap on sent face status |
174 | uint8 *faces_sent; // This is a bitmap on sent face status |
165 | statsinfo stats; |
175 | statsinfo stats; |
|
|
176 | int ACC (RO, active); |
166 | |
177 | |
167 | client_container cc_inv, cc_other; |
178 | Buffer outputbuffer; |
168 | |
179 | |
169 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
180 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
170 | uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ |
181 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
171 | Buffer outputbuffer; |
|
|
172 | |
182 | |
|
|
183 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
|
|
184 | uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */ |
|
|
185 | float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */ |
|
|
186 | sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */ |
|
|
187 | sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */ |
|
|
188 | uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */ |
|
|
189 | uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
|
|
190 | uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
|
|
191 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
|
|
192 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
|
|
193 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
|
|
194 | sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
|
|
195 | |
|
|
196 | bool ACC (RW, afk); /* player is afk */ |
173 | bool ACC (RW, facecache); /* If true, client is caching images */ |
197 | bool ACC (RW, facecache); /* If true, client is caching images */ |
174 | bool ACC (RW, sent_scroll); |
198 | bool ACC (RW, sent_scroll); |
175 | bool ACC (RW, sound); /* does the client want sound */ |
199 | bool ACC (RW, sound); /* does the client want sound */ |
176 | bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */ |
|
|
177 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
200 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
178 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
201 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
179 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
202 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
180 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
203 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
181 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
204 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
… | |
… | |
198 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
221 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
199 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
222 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
200 | uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ |
223 | uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ |
201 | |
224 | |
202 | maptile *ACC (RW, current_map); // CF+ last/current player map |
225 | maptile *ACC (RW, current_map); // CF+ last/current player map |
|
|
226 | region *ACC (RW, current_region); // CF+ last/current player region |
203 | 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 |
204 | char ACC (RW, version)[64]; // CF+ client name/version |
228 | char ACC (RW, version)[64]; // CF+ client name/version |
205 | |
229 | |
206 | player *ACC (RO, pl);//TODO should not be here, preferably |
230 | player_ptr ACC (RO, pl); |
207 | |
231 | |
208 | 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 */ |
209 | |
233 | |
210 | client (int fd, const char *from_ip); |
|
|
211 | ~client (); |
|
|
212 | void destroy (); |
234 | void do_destroy (); |
|
|
235 | void gather_callbacks (AV *&callbacks, event_type event) const; |
213 | |
236 | |
|
|
237 | iow socket_ev; void socket_cb (iow &w, int got); |
214 | iw cmd_ev; void cmd_cb (iw &w); |
238 | iw cmd_ev; void cmd_cb (iw &w); |
215 | iow socket_ev; void socket_cb (iow &w, int got); |
239 | client_container cc_inv, cc_other; |
216 | |
240 | |
217 | std::deque< command, slice_allocator<command> > cmd_queue; |
241 | std::deque< command, slice_allocator<command> > cmd_queue; |
218 | |
|
|
219 | // resets movement state |
|
|
220 | bool may_execute (const packet_type *pkt) const; |
|
|
221 | void execute (const packet_type *pkt, char *data, int datalen); |
|
|
222 | |
|
|
223 | void queue_command (packet_type *handler, char *data, int datalen); |
|
|
224 | bool handle_command (); |
|
|
225 | void reset_state (); |
|
|
226 | |
|
|
227 | bool handle_packet (); |
|
|
228 | int next_packet (); // returns length of packet or 0 |
|
|
229 | void skip_packet (int len); // we have processed the packet, skip it |
|
|
230 | |
|
|
231 | void flush (); |
|
|
232 | void write_outputbuffer (); |
|
|
233 | void send (void *buf_, int len); |
|
|
234 | |
|
|
235 | void send_packet (const char *buf); |
|
|
236 | void send_packet (const char *buf, int len); |
|
|
237 | void send_packet_printf (const char *format, ...); |
|
|
238 | void send_packet (packet &sl); |
|
|
239 | |
|
|
240 | // called when something under the player changes |
|
|
241 | void floorbox_update () { update_look = 1; } |
|
|
242 | // called when the player has been moved |
|
|
243 | void floorbox_reset () { look_position = 0; floorbox_update (); } |
|
|
244 | |
242 | |
245 | // large structures at the end please |
243 | // large structures at the end please |
246 | struct Map lastmap; |
244 | struct Map lastmap; |
247 | std::bitset<MAXANIMNUM> anims_sent; |
245 | std::bitset<MAXANIMNUM> anims_sent; |
248 | // if we get an incomplete packet, this is used to hold the data. |
246 | // if we get an incomplete packet, this is used to hold the data. |
249 | // we add 2 byte for the header, one for the trailing 0 byte |
247 | // we add 2 byte for the header, one for the trailing 0 byte |
250 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
248 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
|
|
249 | |
|
|
250 | bool may_execute (const packet_type *pkt) const; |
|
|
251 | void execute (const packet_type *pkt, char *data, int datalen); |
|
|
252 | |
|
|
253 | void queue_command (packet_type *handler, char *data, int datalen); |
|
|
254 | MTH bool handle_command (); |
|
|
255 | // resets movement state |
|
|
256 | MTH void reset_state (); |
|
|
257 | // resets variable data used to send stat diffs |
|
|
258 | MTH void reset_stats (); |
|
|
259 | |
|
|
260 | MTH bool handle_packet (); |
|
|
261 | int next_packet (); // returns length of packet or 0 |
|
|
262 | void skip_packet (int len); // we have processed the packet, skip it |
|
|
263 | |
|
|
264 | MTH void flush (); |
|
|
265 | MTH void write_outputbuffer (); |
|
|
266 | void send (void *buf_, int len); |
|
|
267 | |
|
|
268 | void send_packet (const char *buf); |
|
|
269 | void send_packet (const char *buf, int len); |
|
|
270 | void send_packet_printf (const char *format, ...); |
|
|
271 | void send_packet (packet &sl); |
|
|
272 | |
|
|
273 | // called when something under the player changes |
|
|
274 | MTH void floorbox_update () { update_look = 1; } |
|
|
275 | // called when the player has been moved |
|
|
276 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
|
|
277 | |
|
|
278 | MTH static client *create (int fd, const char *peername); |
|
|
279 | |
|
|
280 | protected: |
|
|
281 | client (int fd, const char *from_ip); |
|
|
282 | ~client (); |
251 | }; |
283 | }; |
252 | |
284 | |
253 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
285 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
254 | ( ((__type)>0) &&\ |
286 | ( ((__type)>0) &&\ |
255 | ((__sockPtr)->has_readable_type) && \ |
287 | ((__sockPtr)->has_readable_type) && \ |
… | |
… | |
292 | |
324 | |
293 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
325 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
294 | #define VERSION_SC 1027 |
326 | #define VERSION_SC 1027 |
295 | #define VERSION_INFO "Crossfire+ Server" |
327 | #define VERSION_INFO "Crossfire+ Server" |
296 | |
328 | |
297 | typedef unordered_vector<client *> sockvec; |
329 | typedef object_vector<client, &client::active> sockvec; |
298 | |
330 | |
299 | extern sockvec clients; |
331 | extern sockvec clients; |
|
|
332 | |
|
|
333 | #define for_all_clients(var) \ |
|
|
334 | for (int _i = 0; _i < clients.size (); ++_i) \ |
|
|
335 | declvar (client *, var, clients [_i]) |
|
|
336 | |
300 | extern int nrofpixmaps; //TODO: hrmpf, should go |
337 | extern int nrofpixmaps; //TODO: hrmpf, should go |
301 | |
338 | |
302 | #endif |
339 | #endif |
303 | |
340 | |