1 | /* |
1 | /* |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 | * |
3 | * |
4 | * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
4 | * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 | * |
5 | * |
6 | * Deliantra is free software: you can redistribute it and/or modify it under |
6 | * Deliantra is free software: you can redistribute it and/or modify it under |
7 | * the terms of the Affero GNU General Public License as published by the |
7 | * the terms of the Affero GNU General Public License as published by the |
8 | * Free Software Foundation, either version 3 of the License, or (at your |
8 | * Free Software Foundation, either version 3 of the License, or (at your |
9 | * option) any later version. |
9 | * option) any later version. |
10 | * |
10 | * |
11 | * This program is distributed in the hope that it will be useful, |
11 | * This program is distributed in the hope that it will be useful, |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
14 | * GNU General Public License for more details. |
14 | * GNU General Public License for more details. |
15 | * |
15 | * |
16 | * You should have received a copy of the Affero GNU General Public License |
16 | * You should have received a copy of the Affero GNU General Public License |
17 | * and the GNU General Public License along with this program. If not, see |
17 | * and the GNU General Public License along with this program. If not, see |
18 | * <http://www.gnu.org/licenses/>. |
18 | * <http://www.gnu.org/licenses/>. |
19 | * |
19 | * |
20 | * The authors can be reached via e-mail to <support@deliantra.net> |
20 | * The authors can be reached via e-mail to <support@deliantra.net> |
21 | */ |
21 | */ |
22 | |
22 | |
23 | #ifndef CLIENT_H |
23 | #ifndef CLIENT_H |
24 | #define CLIENT_H |
24 | #define CLIENT_H |
… | |
… | |
89 | struct statsinfo |
89 | struct statsinfo |
90 | { |
90 | { |
91 | char *range, *title; |
91 | char *range, *title; |
92 | }; |
92 | }; |
93 | |
93 | |
94 | /* This contains basic information on the socket structure. status is its |
|
|
95 | * current state. we set up our on buffers for sending/receiving, so we can |
|
|
96 | * handle some higher level functions. fd is the actual file descriptor we |
|
|
97 | * are using. |
|
|
98 | */ |
|
|
99 | |
|
|
100 | // states the socket can be in |
94 | // states the socket can be in |
101 | enum { |
95 | enum { |
102 | ST_DEAD, // socket is dead |
96 | ST_DEAD, // socket is dead |
103 | ST_SETUP, // initial handshake / setup / login |
97 | ST_SETUP, // initial handshake / setup / login |
104 | ST_PLAYING, // logged in an playing |
98 | ST_PLAYING, // logged in an playing |
… | |
… | |
107 | ST_GET_PARTY_PASSWORD, |
101 | ST_GET_PARTY_PASSWORD, |
108 | }; |
102 | }; |
109 | |
103 | |
110 | // a handler for a specific type of packet |
104 | // a handler for a specific type of packet |
111 | enum { |
105 | enum { |
112 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
106 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
113 | PF_PLAYING = 0x02, // must be in playing state |
107 | PF_PLAYING = 0x02, // must be in playing state |
114 | PF_COMMAND0 = 0x04, // command starts at offset 0 |
108 | PF_COMMAND = 0x04, // is a suer command |
115 | PF_COMMAND6 = 0x08, // command starts at offset 6 |
|
|
116 | }; |
109 | }; |
117 | |
110 | |
118 | // face type.s bit 0 means "has meta info prepended" |
111 | // face types. bit 0 means "has meta info prepended" |
119 | enum { |
112 | enum { |
120 | FT_FACE = 0 * 2 + 0, // faces (images) |
113 | FT_IMAGE = 0 * 2 + 0, // images |
121 | FT_MUSIC = 1 * 2 + 1, // background music |
114 | FT_MUSIC = 1 * 2 + 1, // background music |
122 | FT_SOUND = 2 * 2 + 1, // effects |
115 | FT_SOUND = 2 * 2 + 1, // effects |
123 | FT_RSRC = 3 * 2 + 0, // generic data files |
116 | FT_RSRC = 3 * 2 + 0, // generic data files |
124 | FT_NUM, |
117 | FT_NUM, |
125 | }; |
118 | }; |
… | |
… | |
142 | //-GPL |
135 | //-GPL |
143 | |
136 | |
144 | /* how many times we are allowed to give the wrong password before being kicked. */ |
137 | /* how many times we are allowed to give the wrong password before being kicked. */ |
145 | #define MAX_PASSWORD_FAILURES 5 |
138 | #define MAX_PASSWORD_FAILURES 5 |
146 | |
139 | |
|
|
140 | /* This contains basic information on the socket connection. status is its |
|
|
141 | * current state. we set up our on buffers for sending/receiving, so we can |
|
|
142 | * handle some higher level functions. fd is the actual file descriptor we |
|
|
143 | * are using. |
|
|
144 | */ |
147 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
145 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
148 | struct client : zero_initialised, attachable |
146 | struct client : zero_initialised, attachable |
149 | { |
147 | { |
150 | int ACC (RW, fd); |
148 | int ACC (RW, fd); |
151 | unsigned int inbuf_len; // number of bytes valid in inbuf |
149 | unsigned int inbuf_len; // number of bytes valid in inbuf |
… | |
… | |
168 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
166 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
169 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
167 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
170 | sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
168 | sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
171 | |
169 | |
172 | bool ACC (RW, afk); /* player is afk */ |
170 | bool ACC (RW, afk); /* player is afk */ |
173 | bool ACC (RW, sent_scroll); |
171 | bool ACC (RW, sent_scroll); |
174 | bool ACC (RW, sound); /* does the client want sound */ |
172 | bool ACC (RW, sound); /* does the client want sound */ |
175 | bool ACC (RW, bumpmsg); /* give message when bumping into walls */ |
173 | bool ACC (RW, bumpmsg); /* give message when bumping into walls */ |
176 | |
174 | |
177 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
175 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
178 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
176 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
179 | uint8_t ACC (RW, extcmd); // call into extensions/plugins |
177 | uint8 ACC (RW, extcmd); // call into extensions/plugins |
180 | bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */ |
178 | bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */ |
181 | |
179 | |
182 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
180 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
183 | bool ACC (RW, update_spells); // If true, we need to esrv_update_spells |
181 | bool ACC (RW, update_spells); // If true, we need to esrv_update_spells |
184 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
182 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
185 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
183 | uint8 ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
186 | |
184 | |
187 | bool ACC (RW, smoothing); // deliantra-style smoothing |
185 | bool ACC (RW, smoothing); // deliantra-style smoothing |
188 | bool ACC (RW, force_newmap); // force a newmap before next map update |
186 | bool ACC (RW, force_newmap); // force a newmap before next map update |
189 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
187 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
190 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
188 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
191 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
189 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
192 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
190 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
193 | uint8 ACC (RW, faceset); // CF+ selected faceset |
191 | uint8 ACC (RW, tileset); // selected tileset |
|
|
192 | uint8 ACC (RW, ws_version); // websocket protocol versio for framing |
194 | |
193 | |
195 | maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
194 | maptile_ptr ACC (RW, current_map); // last/current player map |
196 | region_ptr ACC (RW, current_region); // CF+ last/current player region |
195 | region_ptr ACC (RW, current_region); // last/current player region |
197 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
196 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
198 | |
197 | |
199 | tstamp ACC (RW, last_send); // last data send on socket. |
198 | tstamp ACC (RW, last_send); // last data send on socket. |
200 | |
199 | |
201 | float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */ |
200 | float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */ |
… | |
… | |
205 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
204 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
206 | |
205 | |
207 | struct tcp_info tcpi; |
206 | struct tcp_info tcpi; |
208 | tstamp next_rate_adjust; |
207 | tstamp next_rate_adjust; |
209 | |
208 | |
|
|
209 | // websocket frame buffer |
|
|
210 | uint8 ws_inbuf_type; // current frame type |
|
|
211 | uint8 *ws_inbuf; |
|
|
212 | uint32 ws_inbuf_len; |
|
|
213 | uint32 ws_inbuf_alloc; |
|
|
214 | |
210 | unordered_vector<char *> mapinfo_queue; |
215 | unordered_vector<char *> mapinfo_queue; |
211 | void mapinfo_queue_clear (); |
216 | void mapinfo_queue_clear (); |
212 | void mapinfo_queue_run (); |
217 | void mapinfo_queue_run (); |
213 | bool mapinfo_try (char *buf); |
218 | bool mapinfo_try (char *buf); |
214 | |
219 | |
215 | struct ixsend { |
220 | struct ixsend { |
216 | int16_t pri; // unused |
221 | sint16 pri; // higher means faces are sent earlier, default 0 |
217 | faceidx idx; |
222 | faceidx idx; |
218 | uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
223 | uint32 ofs; // if != 0, need to send remaining bytes of partial_face |
|
|
224 | uint8 *data; |
|
|
225 | SV *data_sv; |
219 | }; |
226 | }; |
220 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
227 | std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
|
|
228 | MTH void ix_send (faceidx idx, sint16 pri, SV *data_sv); // keeps a copy of data_sv |
|
|
229 | void ix_pop (); // pops topmost ixsend |
221 | |
230 | |
222 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
231 | std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
223 | MTH void flush_fx (); // send fx if required |
232 | MTH void flush_fx (); // send fx if required |
224 | |
233 | |
225 | MTH void invalidate_face (faceidx idx); |
234 | MTH void invalidate_face (faceidx idx); |
… | |
… | |
239 | std::bitset<FT_NUM> fx_want; |
248 | std::bitset<FT_NUM> fx_want; |
240 | |
249 | |
241 | // if we get an incomplete packet, this is used to hold the data. |
250 | // if we get an incomplete packet, this is used to hold the data. |
242 | // we add 2 byte for the header, one for the trailing 0 byte |
251 | // we add 2 byte for the header, one for the trailing 0 byte |
243 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
252 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
|
|
253 | void inbuf_handle (); |
244 | |
254 | |
245 | enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
255 | enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
246 | struct msg_buf |
256 | struct msg_buf |
247 | { |
257 | { |
248 | tick_t expire; |
258 | tick_t expire; |
… | |
… | |
279 | void skip_packet (int len); // we have processed the packet, skip it |
289 | void skip_packet (int len); // we have processed the packet, skip it |
280 | |
290 | |
281 | MTH void flush (); |
291 | MTH void flush (); |
282 | MTH void write_outputbuffer (); |
292 | MTH void write_outputbuffer (); |
283 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
293 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
|
|
294 | void send_raw (void *buf_, int len); |
|
|
295 | |
284 | void send (void *buf_, int len); |
296 | void send (void *buf_, int len); |
285 | |
|
|
286 | void send_packet (const_octet_string buf); |
297 | void send_packet (const_octet_string buf); |
287 | void send_packet (const_octet_string buf, int len); |
298 | void send_packet (const_octet_string buf, int len); |
288 | void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3))); |
299 | void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3))); |
289 | void send_packet (packet &sl); |
300 | void send_packet (packet &sl); |
290 | |
|
|
291 | void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK); |
|
|
292 | |
301 | |
293 | MTH void send_face (faceidx facenum, int pri = 0); |
302 | MTH void send_face (faceidx facenum, int pri = 0); |
294 | MTH void send_faces (object *ob); |
303 | MTH void send_faces (object *ob); |
295 | MTH void send_animation (short anim_num); |
304 | MTH void send_animation (short anim_num); |
296 | void send_msg (int color, const_utf8_string type, const_utf8_string msg); |
305 | void send_msg (int color, const_utf8_string type, const_utf8_string msg); |
… | |
… | |
304 | MTH void tick (); // called every server tick to do housekeeping etc. |
313 | MTH void tick (); // called every server tick to do housekeeping etc. |
305 | |
314 | |
306 | MTH static client *create (int fd, const char *peername); |
315 | MTH static client *create (int fd, const char *peername); |
307 | MTH static void clock (); |
316 | MTH static void clock (); |
308 | MTH static void flush_sockets (); |
317 | MTH static void flush_sockets (); |
|
|
318 | |
|
|
319 | MTH void run (); // start handshake after init |
309 | |
320 | |
310 | protected: |
321 | protected: |
311 | client (int fd, const char *from_ip); |
322 | client (int fd, const char *from_ip); |
312 | ~client (); |
323 | ~client (); |
313 | }; |
324 | }; |