| 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 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
4 | * Copyright (©) 2005,2006,2007,2008,2009,2010,2011 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
| 5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
|
|
| 6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
|
|
| 7 | * |
5 | * |
| 8 | * Deliantra is free software: you can redistribute it and/or modify |
6 | * Deliantra is free software: you can redistribute it and/or modify it under |
| 9 | * it under the terms of the GNU General Public License as published by |
7 | * the terms of the Affero GNU General Public License as published by the |
| 10 | * the Free Software Foundation, either version 3 of the License, or |
8 | * Free Software Foundation, either version 3 of the License, or (at your |
| 11 | * (at your option) any later version. |
9 | * option) any later version. |
| 12 | * |
10 | * |
| 13 | * 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, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU General Public License for more details. |
14 | * GNU General Public License for more details. |
| 17 | * |
15 | * |
| 18 | * You should have received a copy of the GNU General Public License |
16 | * You should have received a copy of the Affero GNU General Public License |
| 19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | * and the GNU General Public License along with this program. If not, see |
|
|
18 | * <http://www.gnu.org/licenses/>. |
| 20 | * |
19 | * |
| 21 | * 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> |
| 22 | */ |
21 | */ |
| 23 | |
22 | |
| 24 | #ifndef CLIENT_H |
23 | #ifndef CLIENT_H |
| 25 | #define CLIENT_H |
24 | #define CLIENT_H |
| 26 | |
|
|
| 27 | #include <deque> |
|
|
| 28 | #include <bitset> |
|
|
| 29 | #include <tr1/unordered_set> |
|
|
| 30 | |
25 | |
| 31 | #if HAVE_TCP_INFO |
26 | #if HAVE_TCP_INFO |
| 32 | # include <netinet/tcp.h> |
27 | # include <netinet/tcp.h> |
| 33 | #else |
28 | #else |
| 34 | struct tcp_info { |
29 | struct tcp_info { |
| … | |
… | |
| 63 | int tcpi_advmss; |
58 | int tcpi_advmss; |
| 64 | int tcpi_reordering; |
59 | int tcpi_reordering; |
| 65 | }; |
60 | }; |
| 66 | #endif |
61 | #endif |
| 67 | |
62 | |
|
|
63 | //+GPL |
|
|
64 | |
| 68 | // (possibly) max. number of objects "per page" in the ground container |
65 | // (possibly) max. number of objects "per page" in the ground container |
| 69 | #define FLOORBOX_PAGESIZE 50 |
66 | #define FLOORBOX_PAGESIZE 50 |
| 70 | |
67 | |
| 71 | struct MapCell |
68 | struct MapCell |
| 72 | { |
69 | { |
| … | |
… | |
| 97 | /* This contains basic information on the socket structure. status is its |
94 | /* This contains basic information on the socket structure. status is its |
| 98 | * current state. we set up our on buffers for sending/receiving, so we can |
95 | * current state. we set up our on buffers for sending/receiving, so we can |
| 99 | * handle some higher level functions. fd is the actual file descriptor we |
96 | * handle some higher level functions. fd is the actual file descriptor we |
| 100 | * are using. |
97 | * are using. |
| 101 | */ |
98 | */ |
| 102 | |
|
|
| 103 | /* Only one map mode can actually be used, so lets make it a switch |
|
|
| 104 | * instead of having a bunch of different fields that needed to |
|
|
| 105 | * get toggled. |
|
|
| 106 | */ |
|
|
| 107 | enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
|
|
| 108 | |
99 | |
| 109 | // states the socket can be in |
100 | // states the socket can be in |
| 110 | enum { |
101 | enum { |
| 111 | ST_DEAD, // socket is dead |
102 | ST_DEAD, // socket is dead |
| 112 | ST_SETUP, // initial handshake / setup / login |
103 | ST_SETUP, // initial handshake / setup / login |
| … | |
… | |
| 145 | tstamp stamp; |
136 | tstamp stamp; |
| 146 | const packet_type *handler; |
137 | const packet_type *handler; |
| 147 | char *data; |
138 | char *data; |
| 148 | int datalen; |
139 | int datalen; |
| 149 | }; |
140 | }; |
|
|
141 | |
|
|
142 | //-GPL |
| 150 | |
143 | |
| 151 | /* how many times we are allowed to give the wrong password before being kicked. */ |
144 | /* how many times we are allowed to give the wrong password before being kicked. */ |
| 152 | #define MAX_PASSWORD_FAILURES 5 |
145 | #define MAX_PASSWORD_FAILURES 5 |
| 153 | |
146 | |
| 154 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
147 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
| … | |
… | |
| 172 | uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
165 | uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ |
| 173 | uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
166 | uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ |
| 174 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
167 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
| 175 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
168 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
| 176 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
169 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
| 177 | sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
170 | sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
| 178 | |
|
|
| 179 | bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient |
|
|
| 180 | bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient |
|
|
| 181 | bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload |
|
|
| 182 | bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images |
|
|
| 183 | |
171 | |
| 184 | bool ACC (RW, afk); /* player is afk */ |
172 | bool ACC (RW, afk); /* player is afk */ |
| 185 | bool ACC (RW, facecache); /* If true, client is caching images */ |
|
|
| 186 | bool ACC (RW, sent_scroll); |
173 | bool ACC (RW, sent_scroll); |
| 187 | bool ACC (RW, sound); /* does the client want sound */ |
174 | bool ACC (RW, sound); /* does the client want sound */ |
| 188 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
175 | bool ACC (RW, bumpmsg); /* give message when bumping into walls */ |
|
|
176 | |
| 189 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
177 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
| 190 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
178 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
| 191 | uint8_t ACC (RW, extcmd); // call into extensions/plugins |
179 | uint8_t ACC (RW, extcmd); // call into extensions/plugins |
| 192 | bool ACC (RW, extmap); // extend map comamnd with extra data |
180 | bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */ |
| 193 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
181 | |
| 194 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
|
|
| 195 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
|
|
| 196 | uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
|
|
| 197 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
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 |
| 198 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
184 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
| 199 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
|
|
| 200 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
185 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
| 201 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
186 | |
| 202 | /* Below are flags for extedend infos to pass to client |
|
|
| 203 | * with S->C mapextended command */ |
|
|
| 204 | bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
|
|
| 205 | bool ACC (RW, smoothing); // trt-style smoothing |
187 | bool ACC (RW, smoothing); // deliantra-style smoothing |
| 206 | bool ACC (RW, can_msg); // trt-style text messages |
|
|
| 207 | |
|
|
| 208 | bool ACC (RW, force_newmap); // force a newmap before next map update |
188 | bool ACC (RW, force_newmap); // force a newmap before next map update |
| 209 | uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
|
|
| 210 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
|
|
| 211 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
189 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
| 212 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
190 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
| 213 | uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ |
|
|
| 214 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
191 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
| 215 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
192 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
|
|
193 | uint8 ACC (RW, faceset); // CF+ selected faceset |
| 216 | |
194 | |
| 217 | maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
195 | maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
| 218 | region_ptr ACC (RW, current_region); // CF+ last/current player region |
196 | region_ptr ACC (RW, current_region); // CF+ last/current player region |
| 219 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
197 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
| 220 | shstr ACC (RW, version); // CF+ client name/version |
|
|
| 221 | uint8 ACC (RW, faceset); // CF+ selected faceset |
|
|
| 222 | |
198 | |
| 223 | tstamp ACC (RW, last_send); // last data send on socket. |
199 | tstamp ACC (RW, last_send); // last data send on socket. |
| 224 | |
200 | |
|
|
201 | float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */ |
| 225 | int ACC (RW, rate_avail); // current rate balance |
202 | int ACC (RW, rate_avail); // current rate balance |
| 226 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
203 | int ACC (RW, max_rate); // max. # of bytes to send per tick |
| 227 | faceidx ACC (RW, scrub_idx); // which face to send next |
204 | faceidx ACC (RW, scrub_idx); // which face to send next |
| 228 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
205 | int ACC (RW, bg_scrub); // how many ticks till the next background face send |
| 229 | |
206 | |
| … | |
… | |
| 269 | int len; |
246 | int len; |
| 270 | int count; |
247 | int count; |
| 271 | char msg[MSG_BUF_SIZE]; |
248 | char msg[MSG_BUF_SIZE]; |
| 272 | } msgbuf[MSG_BUF_COUNT]; |
249 | } msgbuf[MSG_BUF_COUNT]; |
| 273 | |
250 | |
| 274 | MTH bool msg_suppressed (const char *msg); |
251 | MTH bool msg_suppressed (const_utf8_string msg); |
| 275 | |
252 | |
| 276 | /* The following is the setup for a ring buffer for storing output |
253 | /* The following is the setup for a ring buffer for storing output |
| 277 | * data that the OS can't handle right away. |
254 | * data that the OS can't handle right away. |
| 278 | * TODO: this member is enourmously large - optimise? |
255 | * TODO: this member is enourmously large - optimise? |
| 279 | */ |
256 | */ |
| … | |
… | |
| 301 | MTH void flush (); |
278 | MTH void flush (); |
| 302 | MTH void write_outputbuffer (); |
279 | MTH void write_outputbuffer (); |
| 303 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
280 | MTH int outputbuffer_len () const { return outputbuffer.len; } |
| 304 | void send (void *buf_, int len); |
281 | void send (void *buf_, int len); |
| 305 | |
282 | |
| 306 | void send_packet (const char *buf); |
283 | void send_packet (const_octet_string buf); |
| 307 | void send_packet (const char *buf, int len); |
284 | void send_packet (const_octet_string buf, int len); |
| 308 | void send_packet_printf (const char *format, ...); |
285 | void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3))); |
| 309 | void send_packet (packet &sl); |
286 | void send_packet (packet &sl); |
| 310 | |
287 | |
| 311 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
288 | void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK); |
| 312 | |
289 | |
| 313 | MTH void send_face (faceidx facenum, int pri = 0); |
290 | MTH void send_face (faceidx facenum, int pri = 0); |
| 314 | MTH void send_image (faceidx facenum); |
|
|
| 315 | MTH void send_faces (object *ob); |
291 | MTH void send_faces (object *ob); |
| 316 | MTH void send_animation (short anim_num); |
292 | MTH void send_animation (short anim_num); |
| 317 | void send_msg (int color, const char *type, const char *msg); |
293 | void send_msg (int color, const_utf8_string type, const_utf8_string msg); |
| 318 | |
294 | |
| 319 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
295 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
| 320 | // called when something under the player changes |
296 | // called when something under the player changes |
| 321 | MTH void floorbox_update () { update_look = 1; } |
297 | MTH void floorbox_update () { update_look = 1; } |
| 322 | // called when the player has been moved |
298 | // called when the player has been moved |
| … | |
… | |
| 363 | ACC (RW, tcpi.tcpi_snd_cwnd); |
339 | ACC (RW, tcpi.tcpi_snd_cwnd); |
| 364 | ACC (RW, tcpi.tcpi_advmss); |
340 | ACC (RW, tcpi.tcpi_advmss); |
| 365 | ACC (RW, tcpi.tcpi_reordering); |
341 | ACC (RW, tcpi.tcpi_reordering); |
| 366 | #endif |
342 | #endif |
| 367 | |
343 | |
|
|
344 | //+GPL |
|
|
345 | |
| 368 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
346 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
| 369 | ( ((__type)>0) &&\ |
347 | ( ((__type)>0) &&\ |
| 370 | ((__sockPtr)->has_readable_type) && \ |
348 | ((__sockPtr)->has_readable_type) && \ |
| 371 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
349 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
| 372 | |
350 | |
| 373 | /* Constants in the form EMI_ is for extended map infos. |
|
|
| 374 | * Even if the client select the additionnal infos it wants |
|
|
| 375 | * on the map, there may exist cases where this whole info |
|
|
| 376 | * is not given in one buch but in separate bunches. This |
|
|
| 377 | * is done performance reasons (imagine some info related to |
|
|
| 378 | * a visible object and another info related to a 4 square |
|
|
| 379 | * width and height area). At the begin of an extended info packet |
|
|
| 380 | * is a bit field. A bit is activated for each extended info |
|
|
| 381 | * present in the data |
|
|
| 382 | */ |
|
|
| 383 | |
|
|
| 384 | /* Meanings: |
|
|
| 385 | * EMI_NOREDRAW Take extended infos into account but don't redraw, |
|
|
| 386 | * some additionnal datas will follow in a new packet |
|
|
| 387 | * EMI_SMOOTH Datas about smoothing |
|
|
| 388 | */ |
|
|
| 389 | #define EMI_NOREDRAW 0x01 |
|
|
| 390 | #define EMI_SMOOTH 0x02 |
|
|
| 391 | |
|
|
| 392 | /* this last one says the bitfield continue un next byte |
|
|
| 393 | * There may be several on contiguous bytes. So there is 7 |
|
|
| 394 | * actual bits used per byte, and the number of bytes |
|
|
| 395 | * is not fixed in protocol |
|
|
| 396 | */ |
|
|
| 397 | #define EMI_HASMOREBITS 0x80 |
|
|
| 398 | |
|
|
| 399 | #define FACE_TYPES 1 |
351 | #define FACE_TYPES 1 |
| 400 | #define PNG_FACE_INDEX 0 |
352 | #define PNG_FACE_INDEX 0 |
| 401 | |
353 | |
| 402 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
354 | //-GPL |
| 403 | #define VERSION_SC 1026 |
|
|
| 404 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
|
|
| 405 | #define VERSION_INFO "Deliantra Server" |
|
|
| 406 | |
355 | |
| 407 | typedef object_vector<client, &client::active> sockvec; |
356 | typedef object_vector<client, &client::active> sockvec; |
| 408 | |
357 | |
| 409 | extern sockvec clients; |
358 | extern sockvec clients; |
| 410 | |
359 | |
| … | |
… | |
| 412 | for (int _i = 0; _i < clients.size (); ++_i) \ |
361 | for (int _i = 0; _i < clients.size (); ++_i) \ |
| 413 | statementvar (client *, var, clients [_i]) |
362 | statementvar (client *, var, clients [_i]) |
| 414 | |
363 | |
| 415 | // returns true when the message needs special (read: perl) treatment |
364 | // returns true when the message needs special (read: perl) treatment |
| 416 | static inline bool |
365 | static inline bool |
| 417 | msg_is_special (const char *msg, bool nl_special = true) |
366 | msg_is_special (const_any_string msg, bool nl_special = true) |
| 418 | { |
367 | { |
| 419 | return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; |
368 | return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; |
| 420 | } |
369 | } |
| 421 | |
370 | |
| 422 | #endif |
371 | #endif |
