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