1 |
/* |
2 |
* This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 |
* |
4 |
* Copyright (©) 2017,2018 Marc Alexander Lehmann / the Deliantra team |
5 |
* Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
6 |
* |
7 |
* Deliantra is free software: you can redistribute it and/or modify it under |
8 |
* the terms of the Affero GNU General Public License as published by the |
9 |
* Free Software Foundation, either version 3 of the License, or (at your |
10 |
* option) any later version. |
11 |
* |
12 |
* This program is distributed in the hope that it will be useful, |
13 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 |
* GNU General Public License for more details. |
16 |
* |
17 |
* You should have received a copy of the Affero GNU General Public License |
18 |
* and the GNU General Public License along with this program. If not, see |
19 |
* <http://www.gnu.org/licenses/>. |
20 |
* |
21 |
* The authors can be reached via e-mail to <support@deliantra.net> |
22 |
*/ |
23 |
|
24 |
#ifndef CLIENT_H |
25 |
#define CLIENT_H |
26 |
|
27 |
#if HAVE_TCP_INFO |
28 |
# include <netinet/tcp.h> |
29 |
#else |
30 |
struct tcp_info { |
31 |
// dummy |
32 |
int tcpi_state; |
33 |
int tcpi_ca_state; |
34 |
int tcpi_retransmits; |
35 |
int tcpi_probes; |
36 |
int tcpi_backoff; |
37 |
int tcpi_options; |
38 |
int tcpi_snd_wscale; |
39 |
int tcpi_rcv_wscale; |
40 |
int tcpi_rto; |
41 |
int tcpi_ato; |
42 |
int tcpi_snd_mss; |
43 |
int tcpi_rcv_mss; |
44 |
int tcpi_unacked; |
45 |
int tcpi_sacked; |
46 |
int tcpi_lost; |
47 |
int tcpi_retrans; |
48 |
int tcpi_fackets; |
49 |
int tcpi_last_data_sent; |
50 |
int tcpi_last_ack_sent; |
51 |
int tcpi_last_data_recv; |
52 |
int tcpi_last_ack_recv; |
53 |
int tcpi_pmtu; |
54 |
int tcpi_rcv_ssthresh; |
55 |
int tcpi_rtt; |
56 |
int tcpi_rttvar; |
57 |
int tcpi_snd_ssthresh; |
58 |
int tcpi_snd_cwnd; |
59 |
int tcpi_advmss; |
60 |
int tcpi_reordering; |
61 |
}; |
62 |
#endif |
63 |
|
64 |
//+GPL |
65 |
|
66 |
// (possibly) max. number of objects "per page" in the ground container |
67 |
#define FLOORBOX_PAGESIZE 50 |
68 |
|
69 |
struct MapCell |
70 |
{ |
71 |
tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
72 |
int count; /* This is really darkness in the map1 command */ |
73 |
faceidx faces[MAP_LAYERS]; |
74 |
unsigned char stat_hp; // health of something in this space, or 0 |
75 |
unsigned char flags; |
76 |
uint8_t smooth[MAP_LAYERS]; |
77 |
}; |
78 |
|
79 |
#define MAX_CLIENT_X MAP_CLIENT_X |
80 |
#define MAX_CLIENT_Y MAP_CLIENT_Y |
81 |
|
82 |
struct Map |
83 |
{ |
84 |
struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
85 |
}; |
86 |
|
87 |
/* True max is 16383 given current map compaction method */ |
88 |
#define MAXANIMNUM 10000 |
89 |
|
90 |
struct statsinfo |
91 |
{ |
92 |
char *range, *title; |
93 |
}; |
94 |
|
95 |
// states the socket can be in |
96 |
enum { |
97 |
ST_DEAD, // socket is dead |
98 |
ST_SETUP, // initial handshake / setup / login |
99 |
ST_PLAYING, // logged in an playing |
100 |
ST_CUSTOM, // waiting for custom reply |
101 |
|
102 |
ST_GET_PARTY_PASSWORD, |
103 |
}; |
104 |
|
105 |
// a handler for a specific type of packet |
106 |
enum { |
107 |
PF_PLAYER = 0x01, // must have valid player / will by synchronised |
108 |
PF_PLAYING = 0x02, // must be in playing state |
109 |
PF_COMMAND = 0x04, // is a user command |
110 |
}; |
111 |
|
112 |
// face types. bit 0 means "has meta info prepended" |
113 |
enum { |
114 |
FT_IMAGE = 0 * 2 + 0, // images |
115 |
FT_MUSIC = 1 * 2 + 1, // background music |
116 |
FT_SOUND = 2 * 2 + 1, // effects |
117 |
FT_RSRC = 3 * 2 + 0, // generic data files |
118 |
FT_NUM, |
119 |
}; |
120 |
|
121 |
struct packet_type |
122 |
{ |
123 |
const char *name; |
124 |
void *cb; |
125 |
int flags; |
126 |
}; |
127 |
|
128 |
struct command |
129 |
{ |
130 |
tstamp stamp; |
131 |
const packet_type *handler; |
132 |
char *data; |
133 |
int datalen; |
134 |
}; |
135 |
|
136 |
//-GPL |
137 |
|
138 |
/* how many times we are allowed to give the wrong password before being kicked. */ |
139 |
#define MAX_PASSWORD_FAILURES 5 |
140 |
|
141 |
/* This contains basic information on the socket connection. status is its |
142 |
* current state. we set up our on buffers for sending/receiving, so we can |
143 |
* handle some higher level functions. fd is the actual file descriptor we |
144 |
* are using. |
145 |
*/ |
146 |
INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
147 |
struct client : zero_initialised, attachable |
148 |
{ |
149 |
int ACC (RW, fd); |
150 |
unsigned int inbuf_len; // number of bytes valid in inbuf |
151 |
statsinfo stats; |
152 |
object_vector_index ACC (RO, active); |
153 |
player_ptr ACC (RO, pl); |
154 |
|
155 |
char *ACC (RW, host); /* Which host it is connected from (ip:port) */ |
156 |
uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
157 |
|
158 |
sint8 ACC (RW, last_level); /* Last level we sent to client */ |
159 |
uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */ |
160 |
float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */ |
161 |
sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */ |
162 |
sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */ |
163 |
uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */ |
164 |
uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
165 |
uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
166 |
living ACC (RO, last_stats); /* Last stats as sent to client */ |
167 |
float ACC (RW, last_speed); /* Last speed as sent to client */ |
168 |
sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
169 |
sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
170 |
|
171 |
bool ACC (RW, afk); /* player is afk */ |
172 |
bool ACC (RW, sent_scroll); |
173 |
bool ACC (RW, sound); /* does the client want sound */ |
174 |
bool ACC (RW, bumpmsg); /* give message when bumping into walls */ |
175 |
|
176 |
bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
177 |
bool ACC (RW, mapinfocmd); // return map info and send map change info |
178 |
uint8 ACC (RW, extcmd); // call into extensions/plugins |
179 |
bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */ |
180 |
|
181 |
bool ACC (RW, update_look); /* If true, we need to send the look window */ |
182 |
bool ACC (RW, update_spells); // If true, we need to esrv_update_spells |
183 |
bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
184 |
uint8 ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
185 |
|
186 |
bool ACC (RW, smoothing); // deliantra-style smoothing |
187 |
bool ACC (RW, force_newmap); // force a newmap before next map update |
188 |
uint16 ACC (RW, look_position); /* start of drawing of look window */ |
189 |
uint16 ACC (RW, mss); // likely tcp maximum segment size |
190 |
uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
191 |
uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
192 |
uint8 ACC (RW, tileset); // selected tileset |
193 |
uint8 ACC (RW, ws_version); // websocket protocol versio for framing |
194 |
|
195 |
maptile_ptr ACC (RW, current_map); // last/current player map |
196 |
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 |
198 |
|
199 |
tstamp ACC (RW, last_send); // last data send on socket. |
200 |
|
201 |
float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */ |
202 |
int ACC (RW, rate_avail); // current rate balance |
203 |
int ACC (RW, max_rate); // max. # of bytes to send per tick |
204 |
faceidx ACC (RW, scrub_idx); // which face to send next |
205 |
int ACC (RW, bg_scrub); // how many ticks till the next background face send |
206 |
|
207 |
struct tcp_info tcpi; |
208 |
tstamp next_rate_adjust; |
209 |
|
210 |
// websocket frame buffer |
211 |
uint8 ws_inbuf_type; // current frame type |
212 |
uint8 *ws_inbuf; |
213 |
uint32 ws_inbuf_len; |
214 |
uint32 ws_inbuf_alloc; |
215 |
|
216 |
unordered_vector<char *> mapinfo_queue; |
217 |
void mapinfo_queue_clear (); |
218 |
void mapinfo_queue_run (); |
219 |
bool mapinfo_try (char *buf); |
220 |
|
221 |
struct ixsend { |
222 |
sint16 pri; // higher means faces are sent earlier, default 0 |
223 |
faceidx idx; |
224 |
uint32 ofs; // if != 0, need to send remaining bytes of partial_face |
225 |
uint8 *data; |
226 |
SV *data_sv; |
227 |
}; |
228 |
std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
229 |
MTH void ix_send (faceidx idx, sint16 pri, SV *data_sv); // keeps a copy of data_sv |
230 |
void ix_pop (); // pops topmost ixsend |
231 |
|
232 |
std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
233 |
MTH void flush_fx (); // send fx if required |
234 |
|
235 |
MTH void invalidate_face (faceidx idx); |
236 |
MTH void invalidate_all_faces (); |
237 |
|
238 |
void do_destroy (); |
239 |
void gather_callbacks (AV *&callbacks, event_type event) const; |
240 |
|
241 |
iow socket_ev; void socket_cb (iow &w, int revents); |
242 |
|
243 |
std::deque< command, slice_allocator<command> > cmd_queue; |
244 |
|
245 |
// large structures at the end please |
246 |
struct Map lastmap; |
247 |
std::bitset<MAXANIMNUM> anims_sent; |
248 |
std::bitset<MAX_FACES> faces_sent; |
249 |
std::bitset<FT_NUM> fx_want; |
250 |
|
251 |
// if we get an incomplete packet, this is used to hold the data. |
252 |
// we add 2 byte for the header, one for the trailing 0 byte |
253 |
uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
254 |
void inbuf_handle (); |
255 |
|
256 |
enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
257 |
struct msg_buf |
258 |
{ |
259 |
tick_t expire; |
260 |
int len; |
261 |
int count; |
262 |
char msg[MSG_BUF_SIZE]; |
263 |
} msgbuf[MSG_BUF_COUNT]; |
264 |
|
265 |
MTH bool msg_suppressed (const_utf8_string msg); |
266 |
|
267 |
/* The following is the setup for a ring buffer for storing output |
268 |
* data that the OS can't handle right away. |
269 |
* TODO: this member is enourmously large - optimise? |
270 |
*/ |
271 |
struct |
272 |
{ |
273 |
char data[SOCKETBUFSIZE]; |
274 |
int start; |
275 |
int len; |
276 |
} outputbuffer; |
277 |
|
278 |
bool may_execute (const packet_type *pkt) const; |
279 |
void execute (const packet_type *pkt, char *data, int datalen); |
280 |
|
281 |
void queue_command (packet_type *handler, char *data, int datalen); |
282 |
MTH bool handle_command (); |
283 |
// resets movement state |
284 |
MTH void reset_state (); |
285 |
// resets variable data used to send stat diffs |
286 |
MTH void reset_stats (); |
287 |
|
288 |
MTH bool handle_packet (); |
289 |
int next_packet (); // returns length of packet or 0 |
290 |
void skip_packet (int len); // we have processed the packet, skip it |
291 |
|
292 |
MTH void flush (); |
293 |
MTH void write_outputbuffer (); |
294 |
MTH int outputbuffer_len () const { return outputbuffer.len; } |
295 |
void send_raw (void *buf_, int len); |
296 |
|
297 |
void send (void *buf_, int len); |
298 |
void send_packet (const_octet_string buf); |
299 |
void send_packet (const_octet_string buf, int len); |
300 |
void send_packet_printf (const_utf8_string format, ...) ecb_attribute ((format (printf, 2, 3))); |
301 |
void send_packet (packet &sl); |
302 |
|
303 |
MTH void send_face (faceidx facenum, int pri = 0); |
304 |
MTH void send_faces (object *ob); |
305 |
MTH void send_animation (short anim_num); |
306 |
void send_msg (int color, const_utf8_string type, const_utf8_string msg); |
307 |
|
308 |
MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
309 |
// called when something under the player changes |
310 |
MTH void floorbox_update () { update_look = 1; } |
311 |
// called when the player has been moved |
312 |
MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
313 |
|
314 |
MTH void tick (); // called every server tick to do housekeeping etc. |
315 |
|
316 |
MTH static client *create (int fd, const char *peername); |
317 |
MTH static void clock (); |
318 |
MTH static void flush_sockets (); |
319 |
|
320 |
MTH void run (); // start handshake after init |
321 |
|
322 |
protected: |
323 |
client (int fd, const char *from_ip); |
324 |
~client (); |
325 |
}; |
326 |
|
327 |
#if FOR_PERL |
328 |
ACC (RW, tcpi.tcpi_state); |
329 |
ACC (RW, tcpi.tcpi_ca_state); |
330 |
ACC (RW, tcpi.tcpi_retransmits); |
331 |
ACC (RW, tcpi.tcpi_probes); |
332 |
ACC (RW, tcpi.tcpi_backoff); |
333 |
ACC (RW, tcpi.tcpi_options); |
334 |
ACC (RO, tcpi.tcpi_snd_wscale); |
335 |
ACC (RO, tcpi.tcpi_rcv_wscale); |
336 |
ACC (RW, tcpi.tcpi_rto); |
337 |
ACC (RW, tcpi.tcpi_ato); |
338 |
ACC (RW, tcpi.tcpi_snd_mss); |
339 |
ACC (RW, tcpi.tcpi_rcv_mss); |
340 |
ACC (RW, tcpi.tcpi_unacked); |
341 |
ACC (RW, tcpi.tcpi_sacked); |
342 |
ACC (RW, tcpi.tcpi_lost); |
343 |
ACC (RW, tcpi.tcpi_retrans); |
344 |
ACC (RW, tcpi.tcpi_fackets); |
345 |
ACC (RW, tcpi.tcpi_last_data_sent); |
346 |
ACC (RW, tcpi.tcpi_last_ack_sent); |
347 |
ACC (RW, tcpi.tcpi_last_data_recv); |
348 |
ACC (RW, tcpi.tcpi_last_ack_recv); |
349 |
ACC (RW, tcpi.tcpi_pmtu); |
350 |
ACC (RW, tcpi.tcpi_rcv_ssthresh); |
351 |
ACC (RW, tcpi.tcpi_rtt); |
352 |
ACC (RW, tcpi.tcpi_rttvar); |
353 |
ACC (RW, tcpi.tcpi_snd_ssthresh); |
354 |
ACC (RW, tcpi.tcpi_snd_cwnd); |
355 |
ACC (RW, tcpi.tcpi_advmss); |
356 |
ACC (RW, tcpi.tcpi_reordering); |
357 |
#endif |
358 |
|
359 |
typedef object_vector<client, &client::active> sockvec; |
360 |
|
361 |
extern sockvec clients; |
362 |
|
363 |
#define for_all_clients(var) \ |
364 |
for (int _i = 0; _i < clients.size (); ++_i) \ |
365 |
statementvar (client *, var, clients [_i]) |
366 |
|
367 |
// returns true when the message needs special (read: perl) treatment |
368 |
static inline bool |
369 |
msg_is_special (const_any_string msg, bool nl_special = true) |
370 |
{ |
371 |
return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; |
372 |
} |
373 |
|
374 |
#endif |
375 |
|