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> |
28 | #include <bitset> |
29 | #include <bitset> |
29 | #include <list> |
30 | #include <tr1/unordered_set> |
30 | |
31 | |
31 | // (possibly) max. number of objects "per page" in the ground container |
32 | // (possibly) max. number of objects "per page" in the ground container |
32 | #define FLOORBOX_PAGESIZE 50 |
33 | #define FLOORBOX_PAGESIZE 50 |
33 | |
34 | |
34 | struct MapCell |
35 | struct MapCell |
… | |
… | |
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 outbut |
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 |
96 | }; |
105 | }; |
97 | |
106 | |
98 | struct packet_type |
107 | struct packet_type |
99 | { |
108 | { |
100 | const char *name; |
109 | const char *name; |
… | |
… | |
113 | { |
122 | { |
114 | sfree<char> (data, datalen + 1); |
123 | sfree<char> (data, datalen + 1); |
115 | } |
124 | } |
116 | }; |
125 | }; |
117 | |
126 | |
|
|
127 | struct refitem |
|
|
128 | { |
|
|
129 | object_ptr op; |
|
|
130 | }; |
|
|
131 | |
118 | // this represents a container on the client side. |
132 | // this represents a container on the client side. |
119 | // right now, there are only ever two of them: |
133 | // right now, there are only ever two of them: |
120 | // the inventory and the floor/open container |
134 | // the inventory and the floor/open container |
121 | //TODO: unused as of yet |
135 | //TODO: unused as of yet |
122 | struct client_container |
136 | struct client_container : vector< refitem, slice_allocator<refitem> > |
123 | { |
137 | { |
|
|
138 | client *ns; |
124 | enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type; |
139 | enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type; |
125 | |
140 | |
|
|
141 | bool item_changed; // one of the items in here possibly changed |
|
|
142 | |
126 | // for mapspace and container |
143 | // for mapspace and container |
127 | sint16 x, y; |
144 | int x, y; |
128 | maptile *map; |
145 | maptile *map; |
129 | |
146 | |
130 | // for container |
147 | // for container |
131 | object *env; |
148 | object *env; |
|
|
149 | |
|
|
150 | client_container (client *ns) |
|
|
151 | : ns (ns), type (CC_NONE) { } |
|
|
152 | |
|
|
153 | tag_t tag () const; |
|
|
154 | |
|
|
155 | inline iterator merge_item (iterator i, object *op); |
|
|
156 | |
|
|
157 | void clear (); |
|
|
158 | void update (); |
|
|
159 | |
|
|
160 | void set_mapspace (maptile *map, int x, int y); |
|
|
161 | void set_container (object *env); |
132 | }; |
162 | }; |
133 | |
163 | |
134 | /* how many times we are allowed to give the wrong password before being kicked. */ |
164 | /* how many times we are allowed to give the wrong password before being kicked. */ |
135 | #define MAX_PASSWORD_FAILURES 5 |
165 | #define MAX_PASSWORD_FAILURES 5 |
136 | |
166 | |
137 | ACC_CLASS (client) // should become player when newsocket is a baseclass of player |
167 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
138 | struct client : zero_initialised, attachable_base |
168 | struct client : zero_initialised, attachable |
139 | { |
169 | { |
140 | enum Sock_Status status; |
|
|
141 | int ACC (RW, fd); |
170 | int ACC (RW, fd); |
142 | unsigned int inbuf_len; // number of bytes valid in inbuf |
171 | unsigned int inbuf_len; // number of bytes valid in inbuf |
143 | uint8 *faces_sent; // This is a bitmap on sent face status |
172 | uint8 *faces_sent; // This is a bitmap on sent face status |
144 | statsinfo stats; |
173 | statsinfo stats; |
|
|
174 | int ACC (RO, active); |
145 | |
175 | |
146 | client_container cc_inv, cc_other; |
176 | client_container cc_inv, cc_other; |
|
|
177 | Buffer outputbuffer; |
147 | |
178 | |
148 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
179 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
149 | uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ |
180 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
150 | Buffer outputbuffer; |
|
|
151 | |
181 | |
|
|
182 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
|
|
183 | uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */ |
|
|
184 | float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */ |
|
|
185 | sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */ |
|
|
186 | sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */ |
|
|
187 | uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */ |
|
|
188 | uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
|
|
189 | uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
|
|
190 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
|
|
191 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
|
|
192 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
|
|
193 | sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
|
|
194 | |
|
|
195 | bool ACC (RW, afk); /* player is afk */ |
152 | bool ACC (RW, facecache); /* If true, client is caching images */ |
196 | bool ACC (RW, facecache); /* If true, client is caching images */ |
153 | bool ACC (RW, sent_scroll); |
197 | bool ACC (RW, sent_scroll); |
154 | bool ACC (RW, sound); /* does the client want sound */ |
198 | bool ACC (RW, sound); /* does the client want sound */ |
155 | bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */ |
|
|
156 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
199 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
157 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
200 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
158 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
201 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
159 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
202 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
160 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
203 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
… | |
… | |
180 | |
223 | |
181 | maptile *ACC (RW, current_map); // CF+ last/current player map |
224 | maptile *ACC (RW, current_map); // CF+ last/current player map |
182 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
225 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
183 | char ACC (RW, version)[64]; // CF+ client name/version |
226 | char ACC (RW, version)[64]; // CF+ client name/version |
184 | |
227 | |
185 | player *ACC (RO, pl);//TODO should not be here, preferably |
228 | player_ptr ACC (RO, pl); |
186 | |
229 | |
187 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
230 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
188 | |
231 | |
189 | client (int fd, const char *from_ip); |
|
|
190 | ~client (); |
|
|
191 | void destroy (); |
232 | void do_destroy (); |
|
|
233 | void gather_callbacks (AV *&callbacks, event_type event) const; |
192 | |
234 | |
193 | iw cmd_ev; void cmd_cb (iw &w); |
235 | iw cmd_ev; void cmd_cb (iw &w); |
194 | iow socket_ev; void socket_cb (iow &w, int got); |
236 | iow socket_ev; void socket_cb (iow &w, int got); |
195 | |
237 | |
196 | std::deque< command, slice_allocator<command> > cmd_queue; |
238 | std::deque< command, slice_allocator<command> > cmd_queue; |
197 | |
|
|
198 | // resets movement state |
|
|
199 | bool may_execute (const packet_type *pkt) const; |
|
|
200 | void execute (const packet_type *pkt, char *data, int datalen); |
|
|
201 | |
|
|
202 | void queue_command (packet_type *handler, char *data, int datalen); |
|
|
203 | bool handle_command (); |
|
|
204 | void reset_state (); |
|
|
205 | |
|
|
206 | bool handle_packet (); |
|
|
207 | int next_packet (); // returns length of packet or 0 |
|
|
208 | void skip_packet (int len); // we have processed the packet, skip it |
|
|
209 | |
|
|
210 | void flush (); |
|
|
211 | void write_outputbuffer (); |
|
|
212 | void send (void *buf_, int len); |
|
|
213 | |
|
|
214 | void send_packet (const char *buf); |
|
|
215 | void send_packet (const char *buf, int len); |
|
|
216 | void send_packet_printf (const char *format, ...); |
|
|
217 | void send_packet (packet &sl); |
|
|
218 | |
|
|
219 | // called when something under the player changes |
|
|
220 | void floorbox_update () { update_look = 1; } |
|
|
221 | // called when the player has been moved |
|
|
222 | void floorbox_reset () { look_position = 0; floorbox_update (); } |
|
|
223 | |
239 | |
224 | // large structures at the end please |
240 | // large structures at the end please |
225 | struct Map lastmap; |
241 | struct Map lastmap; |
226 | std::bitset<MAXANIMNUM> anims_sent; |
242 | std::bitset<MAXANIMNUM> anims_sent; |
227 | // if we get an incomplete packet, this is used to hold the data. |
243 | // if we get an incomplete packet, this is used to hold the data. |
228 | // we add 2 byte for the header, one for the trailing 0 byte |
244 | // we add 2 byte for the header, one for the trailing 0 byte |
229 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
245 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
|
|
246 | |
|
|
247 | bool may_execute (const packet_type *pkt) const; |
|
|
248 | void execute (const packet_type *pkt, char *data, int datalen); |
|
|
249 | |
|
|
250 | void queue_command (packet_type *handler, char *data, int datalen); |
|
|
251 | MTH bool handle_command (); |
|
|
252 | // resets movement state |
|
|
253 | MTH void reset_state (); |
|
|
254 | // resets variable data used to send stat diffs |
|
|
255 | MTH void reset_stats (); |
|
|
256 | |
|
|
257 | MTH bool handle_packet (); |
|
|
258 | int next_packet (); // returns length of packet or 0 |
|
|
259 | void skip_packet (int len); // we have processed the packet, skip it |
|
|
260 | |
|
|
261 | MTH void flush (); |
|
|
262 | MTH void write_outputbuffer (); |
|
|
263 | void send (void *buf_, int len); |
|
|
264 | |
|
|
265 | void send_packet (const char *buf); |
|
|
266 | void send_packet (const char *buf, int len); |
|
|
267 | void send_packet_printf (const char *format, ...); |
|
|
268 | void send_packet (packet &sl); |
|
|
269 | |
|
|
270 | // called when something under the player changes |
|
|
271 | MTH void floorbox_update () { update_look = 1; } |
|
|
272 | // called when the player has been moved |
|
|
273 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
|
|
274 | |
|
|
275 | MTH static client *create (int fd, const char *peername); |
|
|
276 | |
|
|
277 | protected: |
|
|
278 | client (int fd, const char *from_ip); |
|
|
279 | ~client (); |
230 | }; |
280 | }; |
231 | |
281 | |
232 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
282 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
233 | ( ((__type)>0) &&\ |
283 | ( ((__type)>0) &&\ |
234 | ((__sockPtr)->has_readable_type) && \ |
284 | ((__sockPtr)->has_readable_type) && \ |
… | |
… | |
271 | |
321 | |
272 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
322 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
273 | #define VERSION_SC 1027 |
323 | #define VERSION_SC 1027 |
274 | #define VERSION_INFO "Crossfire+ Server" |
324 | #define VERSION_INFO "Crossfire+ Server" |
275 | |
325 | |
276 | typedef unordered_vector<client *> sockvec; |
326 | typedef object_vector<client, &client::active> sockvec; |
277 | |
327 | |
278 | extern sockvec clients; |
328 | extern sockvec clients; |
|
|
329 | |
|
|
330 | #define for_all_clients(var) \ |
|
|
331 | for (int _i = 0; _i < clients.size (); ++_i) \ |
|
|
332 | declvar (client *, var, clients [_i]) |
|
|
333 | |
279 | extern int nrofpixmaps; //TODO: hrmpf, should go |
334 | extern int nrofpixmaps; //TODO: hrmpf, should go |
280 | |
335 | |
281 | #endif |
336 | #endif |
282 | |
337 | |