1 |
/* |
2 |
* This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 |
* |
4 |
* Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 |
* |
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 |
8 |
* Free Software Foundation, either version 3 of the License, or (at your |
9 |
* option) any later version. |
10 |
* |
11 |
* 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 |
* |
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 |
18 |
* <http://www.gnu.org/licenses/>. |
19 |
* |
20 |
* The authors can be reached via e-mail to <support@deliantra.net> |
21 |
*/ |
22 |
|
23 |
#ifndef CLIENT_H |
24 |
#define CLIENT_H |
25 |
|
26 |
#if HAVE_TCP_INFO |
27 |
# include <netinet/tcp.h> |
28 |
#else |
29 |
struct tcp_info { |
30 |
// dummy |
31 |
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 |
}; |
61 |
#endif |
62 |
|
63 |
//+GPL |
64 |
|
65 |
// (possibly) max. number of objects "per page" in the ground container |
66 |
#define FLOORBOX_PAGESIZE 50 |
67 |
|
68 |
struct MapCell |
69 |
{ |
70 |
tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
71 |
int count; /* This is really darkness in the map1 command */ |
72 |
faceidx faces[MAP_LAYERS]; |
73 |
unsigned char stat_hp; // health of something in this space, or 0 |
74 |
unsigned char flags; |
75 |
uint8_t smooth[MAP_LAYERS]; |
76 |
}; |
77 |
|
78 |
#define MAX_CLIENT_X MAP_CLIENT_X |
79 |
#define MAX_CLIENT_Y MAP_CLIENT_Y |
80 |
|
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 |
#define MAXANIMNUM 10000 |
88 |
|
89 |
struct statsinfo |
90 |
{ |
91 |
char *range, *title; |
92 |
}; |
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 |
101 |
enum { |
102 |
ST_DEAD, // socket is dead |
103 |
ST_SETUP, // initial handshake / setup / login |
104 |
ST_PLAYING, // logged in an playing |
105 |
ST_CUSTOM, // waiting for custom reply |
106 |
|
107 |
ST_GET_PARTY_PASSWORD, |
108 |
}; |
109 |
|
110 |
// a handler for a specific type of packet |
111 |
enum { |
112 |
PF_PLAYER = 0x01, // must have valid player / will by synchronised |
113 |
PF_PLAYING = 0x02, // must be in playing state |
114 |
PF_COMMAND0 = 0x04, // command starts at offset 0 |
115 |
PF_COMMAND6 = 0x08, // command starts at offset 6 |
116 |
}; |
117 |
|
118 |
// face type.s bit 0 means "has meta info prepended" |
119 |
enum { |
120 |
FT_FACE = 0 * 2 + 0, // faces (images) |
121 |
FT_MUSIC = 1 * 2 + 1, // background music |
122 |
FT_SOUND = 2 * 2 + 1, // effects |
123 |
FT_RSRC = 3 * 2 + 0, // generic data files |
124 |
FT_NUM, |
125 |
}; |
126 |
|
127 |
struct packet_type |
128 |
{ |
129 |
const char *name; |
130 |
void *cb; |
131 |
int flags; |
132 |
}; |
133 |
|
134 |
struct command |
135 |
{ |
136 |
tstamp stamp; |
137 |
const packet_type *handler; |
138 |
char *data; |
139 |
int datalen; |
140 |
}; |
141 |
|
142 |
//-GPL |
143 |
|
144 |
/* how many times we are allowed to give the wrong password before being kicked. */ |
145 |
#define MAX_PASSWORD_FAILURES 5 |
146 |
|
147 |
INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
148 |
struct client : zero_initialised, attachable |
149 |
{ |
150 |
int ACC (RW, fd); |
151 |
unsigned int inbuf_len; // number of bytes valid in inbuf |
152 |
statsinfo stats; |
153 |
object_vector_index ACC (RO, active); |
154 |
player_ptr ACC (RO, pl); |
155 |
|
156 |
char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
157 |
uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
158 |
|
159 |
sint8 ACC (RW, last_level); /* Last level we sent to client */ |
160 |
uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */ |
161 |
float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */ |
162 |
sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */ |
163 |
sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */ |
164 |
uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */ |
165 |
uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
166 |
uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
167 |
living ACC (RO, last_stats); /* Last stats as sent to client */ |
168 |
float ACC (RW, last_speed); /* Last speed as sent to client */ |
169 |
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 */ |
171 |
|
172 |
bool ACC (RW, afk); /* player is afk */ |
173 |
bool ACC (RW, sent_scroll); |
174 |
bool ACC (RW, sound); /* does the client want sound */ |
175 |
bool ACC (RW, bumpmsg); /* give message when bumping into walls */ |
176 |
|
177 |
bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
178 |
bool ACC (RW, mapinfocmd); // return map info and send map change info |
179 |
uint8_t ACC (RW, extcmd); // call into extensions/plugins |
180 |
bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */ |
181 |
|
182 |
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 |
184 |
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 */ |
186 |
|
187 |
bool ACC (RW, smoothing); // deliantra-style smoothing |
188 |
bool ACC (RW, force_newmap); // force a newmap before next map update |
189 |
uint16 ACC (RW, look_position); /* start of drawing of look window */ |
190 |
uint16 ACC (RW, mss); // likely tcp maximum segment size |
191 |
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 */ |
193 |
uint8 ACC (RW, faceset); // CF+ selected faceset |
194 |
|
195 |
maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
196 |
region_ptr ACC (RW, current_region); // CF+ 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 |
unordered_vector<char *> mapinfo_queue; |
211 |
void mapinfo_queue_clear (); |
212 |
void mapinfo_queue_run (); |
213 |
bool mapinfo_try (char *buf); |
214 |
|
215 |
struct ixsend { |
216 |
int16_t pri; // unused |
217 |
faceidx idx; |
218 |
uint32_t ofs; // if != 0, need to send remaining bytes of partial_face |
219 |
}; |
220 |
std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix |
221 |
|
222 |
std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
223 |
MTH void flush_fx (); // send fx if required |
224 |
|
225 |
MTH void invalidate_face (faceidx idx); |
226 |
MTH void invalidate_all_faces (); |
227 |
|
228 |
void do_destroy (); |
229 |
void gather_callbacks (AV *&callbacks, event_type event) const; |
230 |
|
231 |
iow socket_ev; void socket_cb (iow &w, int revents); |
232 |
|
233 |
std::deque< command, slice_allocator<command> > cmd_queue; |
234 |
|
235 |
// large structures at the end please |
236 |
struct Map lastmap; |
237 |
std::bitset<MAXANIMNUM> anims_sent; |
238 |
std::bitset<MAX_FACES> faces_sent; |
239 |
std::bitset<FT_NUM> fx_want; |
240 |
|
241 |
// 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 |
243 |
uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
244 |
|
245 |
enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; |
246 |
struct msg_buf |
247 |
{ |
248 |
tick_t expire; |
249 |
int len; |
250 |
int count; |
251 |
char msg[MSG_BUF_SIZE]; |
252 |
} msgbuf[MSG_BUF_COUNT]; |
253 |
|
254 |
MTH bool msg_suppressed (const_utf8_string msg); |
255 |
|
256 |
/* The following is the setup for a ring buffer for storing output |
257 |
* data that the OS can't handle right away. |
258 |
* TODO: this member is enourmously large - optimise? |
259 |
*/ |
260 |
struct |
261 |
{ |
262 |
char data[SOCKETBUFSIZE]; |
263 |
int start; |
264 |
int len; |
265 |
} outputbuffer; |
266 |
|
267 |
bool may_execute (const packet_type *pkt) const; |
268 |
void execute (const packet_type *pkt, char *data, int datalen); |
269 |
|
270 |
void queue_command (packet_type *handler, char *data, int datalen); |
271 |
MTH bool handle_command (); |
272 |
// resets movement state |
273 |
MTH void reset_state (); |
274 |
// resets variable data used to send stat diffs |
275 |
MTH void reset_stats (); |
276 |
|
277 |
MTH bool handle_packet (); |
278 |
int next_packet (); // returns length of packet or 0 |
279 |
void skip_packet (int len); // we have processed the packet, skip it |
280 |
|
281 |
MTH void flush (); |
282 |
MTH void write_outputbuffer (); |
283 |
MTH int outputbuffer_len () const { return outputbuffer.len; } |
284 |
void send (void *buf_, int len); |
285 |
|
286 |
void send_packet (const_octet_string buf); |
287 |
void send_packet (const_octet_string buf, int len); |
288 |
void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3))); |
289 |
void send_packet (packet &sl); |
290 |
|
291 |
void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK); |
292 |
|
293 |
MTH void send_face (faceidx facenum, int pri = 0); |
294 |
MTH void send_faces (object *ob); |
295 |
MTH void send_animation (short anim_num); |
296 |
void send_msg (int color, const_utf8_string type, const_utf8_string msg); |
297 |
|
298 |
MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
299 |
// called when something under the player changes |
300 |
MTH void floorbox_update () { update_look = 1; } |
301 |
// called when the player has been moved |
302 |
MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
303 |
|
304 |
MTH void tick (); // called every server tick to do housekeeping etc. |
305 |
|
306 |
MTH static client *create (int fd, const char *peername); |
307 |
MTH static void clock (); |
308 |
MTH static void flush_sockets (); |
309 |
|
310 |
protected: |
311 |
client (int fd, const char *from_ip); |
312 |
~client (); |
313 |
}; |
314 |
|
315 |
#if FOR_PERL |
316 |
ACC (RW, tcpi.tcpi_state); |
317 |
ACC (RW, tcpi.tcpi_ca_state); |
318 |
ACC (RW, tcpi.tcpi_retransmits); |
319 |
ACC (RW, tcpi.tcpi_probes); |
320 |
ACC (RW, tcpi.tcpi_backoff); |
321 |
ACC (RW, tcpi.tcpi_options); |
322 |
ACC (RO, tcpi.tcpi_snd_wscale); |
323 |
ACC (RO, tcpi.tcpi_rcv_wscale); |
324 |
ACC (RW, tcpi.tcpi_rto); |
325 |
ACC (RW, tcpi.tcpi_ato); |
326 |
ACC (RW, tcpi.tcpi_snd_mss); |
327 |
ACC (RW, tcpi.tcpi_rcv_mss); |
328 |
ACC (RW, tcpi.tcpi_unacked); |
329 |
ACC (RW, tcpi.tcpi_sacked); |
330 |
ACC (RW, tcpi.tcpi_lost); |
331 |
ACC (RW, tcpi.tcpi_retrans); |
332 |
ACC (RW, tcpi.tcpi_fackets); |
333 |
ACC (RW, tcpi.tcpi_last_data_sent); |
334 |
ACC (RW, tcpi.tcpi_last_ack_sent); |
335 |
ACC (RW, tcpi.tcpi_last_data_recv); |
336 |
ACC (RW, tcpi.tcpi_last_ack_recv); |
337 |
ACC (RW, tcpi.tcpi_pmtu); |
338 |
ACC (RW, tcpi.tcpi_rcv_ssthresh); |
339 |
ACC (RW, tcpi.tcpi_rtt); |
340 |
ACC (RW, tcpi.tcpi_rttvar); |
341 |
ACC (RW, tcpi.tcpi_snd_ssthresh); |
342 |
ACC (RW, tcpi.tcpi_snd_cwnd); |
343 |
ACC (RW, tcpi.tcpi_advmss); |
344 |
ACC (RW, tcpi.tcpi_reordering); |
345 |
#endif |
346 |
|
347 |
//+GPL |
348 |
|
349 |
#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
350 |
( ((__type)>0) &&\ |
351 |
((__sockPtr)->has_readable_type) && \ |
352 |
((__sockPtr)->supported_readables & (1<<(__type))) ) |
353 |
|
354 |
#define FACE_TYPES 1 |
355 |
#define PNG_FACE_INDEX 0 |
356 |
|
357 |
//-GPL |
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 |
|