1 | /* |
1 | /* |
2 | * CrossFire, A Multiplayer game for the X Window System |
2 | * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. |
3 | * |
3 | * |
4 | * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
5 | * Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
6 | * Copyright (C) 1992 Frank Tore Johansen |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
7 | * |
7 | * |
8 | * This program is free software; you can redistribute it and/or modify |
8 | * Crossfire TRT is free software; you can redistribute it and/or modify it |
9 | * it under the terms of the GNU General Public License as published by |
9 | * under the terms of the GNU General Public License as published by the Free |
10 | * the Free Software Foundation; either version 2 of the License, or |
10 | * Software Foundation; either version 2 of the License, or (at your option) |
11 | * (at your option) any later version. |
11 | * 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, but |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
16 | * GNU General Public License for more details. |
16 | * 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 along |
19 | * along with this program; if not, write to the Free Software |
19 | * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 |
20 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
20 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
21 | * |
21 | * |
22 | * The author can be reached via e-mail to crossfire@schmorp.de |
22 | * The authors 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 | |
… | |
… | |
32 | // (possibly) max. number of objects "per page" in the ground container |
32 | // (possibly) max. number of objects "per page" in the ground container |
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 | tag_t 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 | faceidx faces[MAP_LAYERS]; |
39 | faceidx faces[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 | uint8_t smooth[MAP_LAYERS]; |
… | |
… | |
66 | |
66 | |
67 | /* Only one map mode can actually be used, so lets make it a switch |
67 | /* Only one map mode can actually be used, so lets make it a switch |
68 | * instead of having a bunch of different fields that needed to |
68 | * instead of having a bunch of different fields that needed to |
69 | * get toggled. |
69 | * get toggled. |
70 | */ |
70 | */ |
71 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
71 | enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
72 | |
|
|
73 | /* The following is the setup for a ring buffer for storing output |
|
|
74 | * data that the OS can't handle right away. |
|
|
75 | */ |
|
|
76 | struct Buffer |
|
|
77 | { |
|
|
78 | char data[SOCKETBUFSIZE]; |
|
|
79 | int start; |
|
|
80 | int len; |
|
|
81 | }; |
|
|
82 | |
72 | |
83 | // states the socket can be in |
73 | // states the socket can be in |
84 | enum { |
74 | enum { |
85 | ST_DEAD, // socket is dead |
75 | ST_DEAD, // socket is dead |
86 | ST_SETUP, // initial handshake / setup / login |
76 | ST_SETUP, // initial handshake / setup / login |
87 | ST_PLAYING, // logged in an playing |
77 | ST_PLAYING, // logged in an playing |
88 | ST_CUSTOM, // waiting for custom reply |
78 | ST_CUSTOM, // waiting for custom reply |
89 | |
79 | |
90 | ST_CHANGE_CLASS, |
|
|
91 | ST_GET_PARTY_PASSWORD, |
80 | ST_GET_PARTY_PASSWORD, |
92 | }; |
81 | }; |
93 | |
82 | |
94 | // a handler for a specific type of packet |
83 | // a handler for a specific type of packet |
95 | enum { |
84 | enum { |
… | |
… | |
117 | { |
106 | { |
118 | sfree<char> (data, datalen + 1); |
107 | sfree<char> (data, datalen + 1); |
119 | } |
108 | } |
120 | }; |
109 | }; |
121 | |
110 | |
122 | struct refitem |
|
|
123 | { |
|
|
124 | object_ptr op; |
|
|
125 | }; |
|
|
126 | |
|
|
127 | // this represents a container on the client side. |
|
|
128 | // right now, there are only ever two of them: |
|
|
129 | // the inventory and the floor/open container |
|
|
130 | //TODO: unused as of yet |
|
|
131 | struct client_container : vector< refitem, slice_allocator<refitem> > |
|
|
132 | { |
|
|
133 | client *ns; |
|
|
134 | enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type; |
|
|
135 | |
|
|
136 | bool item_changed; // one of the items in here possibly changed |
|
|
137 | |
|
|
138 | // for mapspace and container |
|
|
139 | int x, y; |
|
|
140 | maptile *map; |
|
|
141 | |
|
|
142 | // for container |
|
|
143 | object *env; |
|
|
144 | |
|
|
145 | client_container (client *ns) |
|
|
146 | : ns (ns), type (CC_NONE) { } |
|
|
147 | |
|
|
148 | tag_t tag () const; |
|
|
149 | |
|
|
150 | inline iterator merge_item (iterator i, object *op); |
|
|
151 | |
|
|
152 | void clear (); |
|
|
153 | void update (); |
|
|
154 | |
|
|
155 | void set_mapspace (maptile *map, int x, int y); |
|
|
156 | void set_container (object *env); |
|
|
157 | }; |
|
|
158 | |
|
|
159 | /* how many times we are allowed to give the wrong password before being kicked. */ |
111 | /* how many times we are allowed to give the wrong password before being kicked. */ |
160 | #define MAX_PASSWORD_FAILURES 5 |
112 | #define MAX_PASSWORD_FAILURES 5 |
161 | |
113 | |
162 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
114 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
163 | struct client : zero_initialised, attachable |
115 | struct client : zero_initialised, attachable |
164 | { |
116 | { |
165 | int ACC (RW, fd); |
117 | int ACC (RW, fd); |
166 | unsigned int inbuf_len; // number of bytes valid in inbuf |
118 | unsigned int inbuf_len; // number of bytes valid in inbuf |
167 | statsinfo stats; |
119 | statsinfo stats; |
168 | int ACC (RO, active); |
120 | object_vector_index ACC (RO, active); |
|
|
121 | player_ptr ACC (RO, pl); |
169 | |
122 | |
170 | Buffer outputbuffer; |
123 | /* The following is the setup for a ring buffer for storing output |
|
|
124 | * data that the OS can't handle right away. |
|
|
125 | */ |
|
|
126 | struct |
|
|
127 | { |
|
|
128 | char data[SOCKETBUFSIZE]; |
|
|
129 | int start; |
|
|
130 | int len; |
|
|
131 | } outputbuffer; |
171 | |
132 | |
172 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
133 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
173 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
134 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
174 | |
135 | |
175 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
136 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
… | |
… | |
183 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
144 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
184 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
145 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
185 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
146 | 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 */ |
147 | sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
187 | |
148 | |
|
|
149 | bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient |
|
|
150 | bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient |
|
|
151 | bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload |
|
|
152 | bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images |
|
|
153 | |
188 | bool ACC (RW, afk); /* player is afk */ |
154 | bool ACC (RW, afk); /* player is afk */ |
189 | bool ACC (RW, facecache); /* If true, client is caching images */ |
155 | bool ACC (RW, facecache); /* If true, client is caching images */ |
190 | bool ACC (RW, sent_scroll); |
156 | bool ACC (RW, sent_scroll); |
191 | bool ACC (RW, sound); /* does the client want sound */ |
157 | bool ACC (RW, sound); /* does the client want sound */ |
192 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
158 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
193 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
159 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
194 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
160 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
195 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
161 | bool ACC (RW, extcmd); // call into extensions/plugins |
196 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
162 | bool ACC (RW, extmap); // extend map comamnd with extra data |
197 | bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ |
163 | bool ACC (RW, buggy_mapscroll); // 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 */ |
|
|
200 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
164 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
201 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
165 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
|
|
166 | bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
202 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
167 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
203 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
168 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
204 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
169 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
205 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
170 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
206 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
171 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
207 | /* Below are flags for extedend infos to pass to client |
172 | /* Below are flags for extedend infos to pass to client |
208 | * with S->C mapextended command */ |
173 | * with S->C mapextended command */ |
209 | bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
174 | bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
|
|
175 | bool ACC (RW, smoothing); // trt-style smoothing |
|
|
176 | bool ACC (RW, can_msg); // trt-style text messages |
210 | |
177 | |
|
|
178 | bool ACC (RW, force_newmap); // force a newmap before next map update |
211 | uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
179 | uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
212 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
180 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
213 | enum MapMode mapmode; /* Type of map commands the client wants. */ |
|
|
214 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
181 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
|
|
182 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
|
|
183 | uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ |
215 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
184 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
216 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
185 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
217 | |
186 | |
218 | maptile *ACC (RW, current_map); // CF+ last/current player map |
187 | maptile *ACC (RW, current_map); // CF+ last/current player map |
219 | region *ACC (RW, current_region); // CF+ last/current player region |
188 | region *ACC (RW, current_region); // CF+ last/current player region |
220 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
189 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
221 | char ACC (RW, version)[64]; // CF+ client name/version |
190 | shstr ACC (RW, version); // CF+ client name/version |
222 | uint8 ACC (RW, faceset); // CF+ selected faceset |
191 | uint8 ACC (RW, faceset); // CF+ selected faceset |
223 | |
192 | |
224 | player_ptr ACC (RO, pl); |
193 | tstamp ACC (RW, last_send); // last data send on socket. |
225 | |
194 | |
226 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
195 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
|
|
196 | |
|
|
197 | int ACC (RW, rate_avail); // current rate balance |
|
|
198 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
|
|
199 | faceidx ACC (RW, scrub_idx); // which face to send next |
|
|
200 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
|
|
201 | |
|
|
202 | faceidx partial_face; |
|
|
203 | uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face |
|
|
204 | std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client |
|
|
205 | |
|
|
206 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
|
|
207 | MTH void flush_fx (); // send fx if required |
227 | |
208 | |
228 | void do_destroy (); |
209 | void do_destroy (); |
229 | void gather_callbacks (AV *&callbacks, event_type event) const; |
210 | void gather_callbacks (AV *&callbacks, event_type event) const; |
230 | |
211 | |
231 | iow socket_ev; void socket_cb (iow &w, int got); |
212 | iow socket_ev; void socket_cb (iow &w, int got); |
232 | iw cmd_ev; void cmd_cb (iw &w); |
213 | iw cmd_ev; void cmd_cb (iw &w); |
233 | client_container cc_inv, cc_other; |
|
|
234 | |
214 | |
235 | std::deque< command, slice_allocator<command> > cmd_queue; |
215 | std::deque< command, slice_allocator<command> > cmd_queue; |
236 | |
216 | |
237 | // large structures at the end please |
217 | // large structures at the end please |
238 | struct Map lastmap; |
218 | struct Map lastmap; |
… | |
… | |
240 | std::bitset<MAX_FACES> faces_sent; |
220 | std::bitset<MAX_FACES> faces_sent; |
241 | |
221 | |
242 | // if we get an incomplete packet, this is used to hold the data. |
222 | // if we get an incomplete packet, this is used to hold the data. |
243 | // we add 2 byte for the header, one for the trailing 0 byte |
223 | // we add 2 byte for the header, one for the trailing 0 byte |
244 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
224 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
|
|
225 | |
|
|
226 | enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
|
|
227 | struct msg_buf |
|
|
228 | { |
|
|
229 | tick_t expire; |
|
|
230 | int len; |
|
|
231 | int count; |
|
|
232 | char msg[MSG_BUF_SIZE]; |
|
|
233 | } msgbuf[MSG_BUF_COUNT]; |
|
|
234 | |
|
|
235 | MTH bool msg_suppressed (const char *msg); |
245 | |
236 | |
246 | bool may_execute (const packet_type *pkt) const; |
237 | bool may_execute (const packet_type *pkt) const; |
247 | void execute (const packet_type *pkt, char *data, int datalen); |
238 | void execute (const packet_type *pkt, char *data, int datalen); |
248 | |
239 | |
249 | void queue_command (packet_type *handler, char *data, int datalen); |
240 | void queue_command (packet_type *handler, char *data, int datalen); |
… | |
… | |
257 | int next_packet (); // returns length of packet or 0 |
248 | int next_packet (); // returns length of packet or 0 |
258 | void skip_packet (int len); // we have processed the packet, skip it |
249 | void skip_packet (int len); // we have processed the packet, skip it |
259 | |
250 | |
260 | MTH void flush (); |
251 | MTH void flush (); |
261 | MTH void write_outputbuffer (); |
252 | MTH void write_outputbuffer (); |
|
|
253 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
262 | void send (void *buf_, int len); |
254 | void send (void *buf_, int len); |
263 | |
255 | |
264 | void send_packet (const char *buf); |
256 | void send_packet (const char *buf); |
265 | void send_packet (const char *buf, int len); |
257 | void send_packet (const char *buf, int len); |
266 | void send_packet_printf (const char *format, ...); |
258 | void send_packet_printf (const char *format, ...); |
267 | void send_packet (packet &sl); |
259 | void send_packet (packet &sl); |
268 | |
260 | |
269 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
261 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
270 | MTH void send_face (faceidx facenum, bool nocache = false); |
262 | MTH void send_face (faceidx facenum); |
|
|
263 | MTH void send_image (faceidx facenum); |
271 | MTH void send_faces (object *ob); |
264 | MTH void send_faces (object *ob); |
272 | MTH void send_animation (short anim_num); |
265 | MTH void send_animation (short anim_num); |
|
|
266 | MTH void send_msg (int color, const char *type, const char *msg); |
273 | |
267 | |
274 | // called when something under the player changes |
268 | // called when something under the player changes |
275 | MTH void floorbox_update () { update_look = 1; } |
269 | MTH void floorbox_update () { update_look = 1; } |
276 | // called when the player has been moved |
270 | // called when the player has been moved |
277 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
271 | MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
|
|
272 | |
|
|
273 | MTH void tick (); // called every server tick to do housekeeping etc. |
278 | |
274 | |
279 | MTH static client *create (int fd, const char *peername); |
275 | MTH static client *create (int fd, const char *peername); |
280 | |
276 | |
281 | protected: |
277 | protected: |
282 | client (int fd, const char *from_ip); |
278 | client (int fd, const char *from_ip); |
… | |
… | |
326 | |
322 | |
327 | extern sockvec clients; |
323 | extern sockvec clients; |
328 | |
324 | |
329 | #define for_all_clients(var) \ |
325 | #define for_all_clients(var) \ |
330 | for (int _i = 0; _i < clients.size (); ++_i) \ |
326 | for (int _i = 0; _i < clients.size (); ++_i) \ |
331 | declvar (client *, var, clients [_i]) |
327 | statementvar (client *, var, clients [_i]) |
332 | |
328 | |
333 | #endif |
329 | #endif |
334 | |
330 | |