1 | /* |
1 | /* |
2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 | * |
3 | * |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
4 | * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
5 | * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
7 | * |
7 | * |
8 | * Crossfire TRT is free software: you can redistribute it and/or modify |
8 | * Deliantra is free software: you can redistribute it and/or modify |
9 | * it under the terms of the GNU General Public License as published by |
9 | * it under the terms of the GNU General Public License as published by |
10 | * the Free Software Foundation, either version 3 of the License, or |
10 | * the Free Software Foundation, either version 3 of the License, or |
11 | * (at your option) any later version. |
11 | * (at your option) any later version. |
12 | * |
12 | * |
13 | * This program is distributed in the hope that it will be useful, |
13 | * This program is distributed in the hope that it will be useful, |
… | |
… | |
16 | * GNU General Public License for more details. |
16 | * GNU General Public License for more details. |
17 | * |
17 | * |
18 | * You should have received a copy of the GNU General Public License |
18 | * You should have received a copy of the GNU General Public License |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
20 | * |
20 | * |
21 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
21 | * The authors can be reached via e-mail to <support@deliantra.net> |
22 | */ |
22 | */ |
23 | |
23 | |
24 | #ifndef CLIENT_H |
24 | #ifndef CLIENT_H |
25 | #define CLIENT_H |
25 | #define CLIENT_H |
26 | |
26 | |
… | |
… | |
29 | #include <tr1/unordered_set> |
29 | #include <tr1/unordered_set> |
30 | |
30 | |
31 | #if HAVE_TCP_INFO |
31 | #if HAVE_TCP_INFO |
32 | # include <netinet/tcp.h> |
32 | # include <netinet/tcp.h> |
33 | #else |
33 | #else |
34 | struct tcpi_info { |
34 | struct tcp_info { |
35 | // dummy |
35 | // dummy |
36 | char tcpi_state; |
36 | int tcpi_state; |
37 | char tcpi_ca_state; |
37 | int tcpi_ca_state; |
38 | char tcpi_retransmits; |
38 | int tcpi_retransmits; |
39 | char tcpi_probes; |
39 | int tcpi_probes; |
40 | char tcpi_backoff; |
40 | int tcpi_backoff; |
41 | char tcpi_options; |
41 | int tcpi_options; |
42 | char tcpi_snd_wscale; |
42 | int tcpi_snd_wscale; |
43 | char tcpi_rcv_wscale; |
43 | int tcpi_rcv_wscale; |
44 | char tcpi_rto; |
44 | int tcpi_rto; |
45 | char tcpi_ato; |
45 | int tcpi_ato; |
46 | char tcpi_snd_mss; |
46 | int tcpi_snd_mss; |
47 | char tcpi_rcv_mss; |
47 | int tcpi_rcv_mss; |
48 | char tcpi_unacked; |
48 | int tcpi_unacked; |
49 | char tcpi_sacked; |
49 | int tcpi_sacked; |
50 | char tcpi_lost; |
50 | int tcpi_lost; |
51 | char tcpi_retrans; |
51 | int tcpi_retrans; |
52 | char tcpi_fackets; |
52 | int tcpi_fackets; |
53 | char tcpi_last_data_sent; |
53 | int tcpi_last_data_sent; |
54 | char tcpi_last_ack_sent; |
54 | int tcpi_last_ack_sent; |
55 | char tcpi_last_data_recv; |
55 | int tcpi_last_data_recv; |
56 | char tcpi_last_ack_recv; |
56 | int tcpi_last_ack_recv; |
57 | char tcpi_pmtu; |
57 | int tcpi_pmtu; |
58 | char tcpi_rcv_ssthresh; |
58 | int tcpi_rcv_ssthresh; |
59 | char tcpi_rtt; |
59 | int tcpi_rtt; |
60 | char tcpi_rttvar; |
60 | int tcpi_rttvar; |
61 | char tcpi_snd_ssthresh; |
61 | int tcpi_snd_ssthresh; |
62 | char tcpi_snd_cwnd; |
62 | int tcpi_snd_cwnd; |
63 | char tcpi_advmss; |
63 | int tcpi_advmss; |
64 | char tcpi_reordering; |
64 | int tcpi_reordering; |
65 | }; |
65 | }; |
66 | #endif |
66 | #endif |
67 | |
67 | |
68 | // (possibly) max. number of objects "per page" in the ground container |
68 | // (possibly) max. number of objects "per page" in the ground container |
69 | #define FLOORBOX_PAGESIZE 50 |
69 | #define FLOORBOX_PAGESIZE 50 |
70 | |
70 | |
71 | struct MapCell |
71 | struct MapCell |
72 | { |
72 | { |
73 | tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
73 | tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
74 | int count; /* This is really darkness in the map1 command */ |
74 | int count; /* This is really darkness in the map1 command */ |
75 | faceidx faces[MAP_LAYERS]; |
75 | faceidx faces[MAP_LAYERS]; |
76 | unsigned char stat_hp; // health of something in this space, or 0 |
76 | unsigned char stat_hp; // health of something in this space, or 0 |
77 | unsigned char flags; |
77 | unsigned char flags; |
78 | uint8_t smooth[MAP_LAYERS]; |
78 | uint8_t smooth[MAP_LAYERS]; |
… | |
… | |
144 | { |
144 | { |
145 | tstamp stamp; |
145 | tstamp stamp; |
146 | const packet_type *handler; |
146 | const packet_type *handler; |
147 | char *data; |
147 | char *data; |
148 | int datalen; |
148 | int datalen; |
149 | |
|
|
150 | ~command () |
|
|
151 | { |
|
|
152 | sfree<char> (data, datalen + 1); |
|
|
153 | } |
|
|
154 | }; |
149 | }; |
155 | |
150 | |
156 | /* how many times we are allowed to give the wrong password before being kicked. */ |
151 | /* how many times we are allowed to give the wrong password before being kicked. */ |
157 | #define MAX_PASSWORD_FAILURES 5 |
152 | #define MAX_PASSWORD_FAILURES 5 |
158 | |
153 | |
… | |
… | |
162 | int ACC (RW, fd); |
157 | int ACC (RW, fd); |
163 | unsigned int inbuf_len; // number of bytes valid in inbuf |
158 | unsigned int inbuf_len; // number of bytes valid in inbuf |
164 | statsinfo stats; |
159 | statsinfo stats; |
165 | object_vector_index ACC (RO, active); |
160 | object_vector_index ACC (RO, active); |
166 | player_ptr ACC (RO, pl); |
161 | player_ptr ACC (RO, pl); |
167 | |
|
|
168 | /* The following is the setup for a ring buffer for storing output |
|
|
169 | * data that the OS can't handle right away. |
|
|
170 | */ |
|
|
171 | struct |
|
|
172 | { |
|
|
173 | char data[SOCKETBUFSIZE]; |
|
|
174 | int start; |
|
|
175 | int len; |
|
|
176 | } outputbuffer; |
|
|
177 | |
162 | |
178 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
163 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
179 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
164 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
180 | |
165 | |
181 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
166 | sint8 ACC (RW, last_level); /* Last level we sent to client */ |
… | |
… | |
189 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
174 | living ACC (RO, last_stats); /* Last stats as sent to client */ |
190 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
175 | float ACC (RW, last_speed); /* Last speed as sent to client */ |
191 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
176 | sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ |
192 | sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
177 | sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ |
193 | |
178 | |
194 | bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient |
|
|
195 | bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient |
|
|
196 | bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload |
|
|
197 | bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images |
|
|
198 | |
|
|
199 | bool ACC (RW, afk); /* player is afk */ |
179 | bool ACC (RW, afk); /* player is afk */ |
200 | bool ACC (RW, facecache); /* If true, client is caching images */ |
|
|
201 | bool ACC (RW, sent_scroll); |
180 | bool ACC (RW, sent_scroll); |
202 | bool ACC (RW, sound); /* does the client want sound */ |
181 | bool ACC (RW, sound); /* does the client want sound */ |
203 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
182 | bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
204 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
183 | bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
205 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
184 | bool ACC (RW, mapinfocmd); // return map info and send map change info |
206 | uint8_t ACC (RW, extcmd); // call into extensions/plugins |
185 | uint8_t ACC (RW, extcmd); // call into extensions/plugins |
207 | bool ACC (RW, extmap); // extend map comamnd with extra data |
|
|
208 | bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
|
|
209 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
|
|
210 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
|
|
211 | uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
|
|
212 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
186 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
213 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
187 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
214 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
188 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
215 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
189 | bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
216 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
|
|
217 | /* Below are flags for extedend infos to pass to client |
|
|
218 | * with S->C mapextended command */ |
|
|
219 | bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
|
|
220 | bool ACC (RW, smoothing); // trt-style smoothing |
190 | bool ACC (RW, smoothing); // deliantra-style smoothing |
221 | bool ACC (RW, can_msg); // trt-style text messages |
|
|
222 | |
191 | |
223 | bool ACC (RW, force_newmap); // force a newmap before next map update |
192 | bool ACC (RW, force_newmap); // force a newmap before next map update |
224 | uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
193 | uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
225 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
194 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
226 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
195 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
227 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
196 | uint16 ACC (RW, mss); // likely tcp maximum segment size |
228 | uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ |
197 | uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ |
229 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
198 | uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
230 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
199 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
231 | |
200 | |
232 | maptile *ACC (RW, current_map); // CF+ last/current player map |
201 | maptile_ptr ACC (RW, current_map); // CF+ last/current player map |
233 | region *ACC (RW, current_region); // CF+ last/current player region |
202 | region_ptr ACC (RW, current_region); // CF+ last/current player region |
234 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
203 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
235 | shstr ACC (RW, version); // CF+ client name/version |
204 | shstr ACC (RW, version); // CF+ client name/version |
236 | uint8 ACC (RW, faceset); // CF+ selected faceset |
205 | uint8 ACC (RW, faceset); // CF+ selected faceset |
237 | |
206 | |
238 | tstamp ACC (RW, last_send); // last data send on socket. |
207 | tstamp ACC (RW, last_send); // last data send on socket. |
… | |
… | |
261 | MTH void flush_fx (); // send fx if required |
230 | MTH void flush_fx (); // send fx if required |
262 | |
231 | |
263 | void do_destroy (); |
232 | void do_destroy (); |
264 | void gather_callbacks (AV *&callbacks, event_type event) const; |
233 | void gather_callbacks (AV *&callbacks, event_type event) const; |
265 | |
234 | |
266 | iow socket_ev; void socket_cb (iow &w, int got); |
235 | iow socket_ev; void socket_cb (iow &w, int revents); |
267 | |
236 | |
268 | std::deque< command, slice_allocator<command> > cmd_queue; |
237 | std::deque< command, slice_allocator<command> > cmd_queue; |
269 | |
238 | |
270 | // large structures at the end please |
239 | // large structures at the end please |
271 | struct Map lastmap; |
240 | struct Map lastmap; |
… | |
… | |
286 | char msg[MSG_BUF_SIZE]; |
255 | char msg[MSG_BUF_SIZE]; |
287 | } msgbuf[MSG_BUF_COUNT]; |
256 | } msgbuf[MSG_BUF_COUNT]; |
288 | |
257 | |
289 | MTH bool msg_suppressed (const char *msg); |
258 | MTH bool msg_suppressed (const char *msg); |
290 | |
259 | |
|
|
260 | /* The following is the setup for a ring buffer for storing output |
|
|
261 | * data that the OS can't handle right away. |
|
|
262 | * TODO: this member is enourmously large - optimise? |
|
|
263 | */ |
|
|
264 | struct |
|
|
265 | { |
|
|
266 | char data[SOCKETBUFSIZE]; |
|
|
267 | int start; |
|
|
268 | int len; |
|
|
269 | } outputbuffer; |
|
|
270 | |
291 | bool may_execute (const packet_type *pkt) const; |
271 | bool may_execute (const packet_type *pkt) const; |
292 | void execute (const packet_type *pkt, char *data, int datalen); |
272 | void execute (const packet_type *pkt, char *data, int datalen); |
293 | |
273 | |
294 | void queue_command (packet_type *handler, char *data, int datalen); |
274 | void queue_command (packet_type *handler, char *data, int datalen); |
295 | MTH bool handle_command (); |
275 | MTH bool handle_command (); |
… | |
… | |
313 | void send_packet (packet &sl); |
293 | void send_packet (packet &sl); |
314 | |
294 | |
315 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
295 | void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
316 | |
296 | |
317 | MTH void send_face (faceidx facenum, int pri = 0); |
297 | MTH void send_face (faceidx facenum, int pri = 0); |
318 | MTH void send_image (faceidx facenum); |
|
|
319 | MTH void send_faces (object *ob); |
298 | MTH void send_faces (object *ob); |
320 | MTH void send_animation (short anim_num); |
299 | MTH void send_animation (short anim_num); |
321 | void send_msg (int color, const char *type, const char *msg); |
300 | void send_msg (int color, const char *type, const char *msg); |
322 | |
301 | |
323 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
302 | MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); |
… | |
… | |
372 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
351 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
373 | ( ((__type)>0) &&\ |
352 | ( ((__type)>0) &&\ |
374 | ((__sockPtr)->has_readable_type) && \ |
353 | ((__sockPtr)->has_readable_type) && \ |
375 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
354 | ((__sockPtr)->supported_readables & (1<<(__type))) ) |
376 | |
355 | |
377 | /* Constants in the form EMI_ is for extended map infos. |
|
|
378 | * Even if the client select the additionnal infos it wants |
|
|
379 | * on the map, there may exist cases where this whole info |
|
|
380 | * is not given in one buch but in separate bunches. This |
|
|
381 | * is done performance reasons (imagine some info related to |
|
|
382 | * a visible object and another info related to a 4 square |
|
|
383 | * width and height area). At the begin of an extended info packet |
|
|
384 | * is a bit field. A bit is activated for each extended info |
|
|
385 | * present in the data |
|
|
386 | */ |
|
|
387 | |
|
|
388 | /* Meanings: |
|
|
389 | * EMI_NOREDRAW Take extended infos into account but don't redraw, |
|
|
390 | * some additionnal datas will follow in a new packet |
|
|
391 | * EMI_SMOOTH Datas about smoothing |
|
|
392 | */ |
|
|
393 | #define EMI_NOREDRAW 0x01 |
|
|
394 | #define EMI_SMOOTH 0x02 |
|
|
395 | |
|
|
396 | /* this last one says the bitfield continue un next byte |
|
|
397 | * There may be several on contiguous bytes. So there is 7 |
|
|
398 | * actual bits used per byte, and the number of bytes |
|
|
399 | * is not fixed in protocol |
|
|
400 | */ |
|
|
401 | #define EMI_HASMOREBITS 0x80 |
|
|
402 | |
|
|
403 | #define FACE_TYPES 1 |
356 | #define FACE_TYPES 1 |
404 | #define PNG_FACE_INDEX 0 |
357 | #define PNG_FACE_INDEX 0 |
405 | |
358 | |
406 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
359 | #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
407 | #define VERSION_SC 1026 |
360 | #define VERSION_SC 1026 |
408 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
361 | //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
409 | #define VERSION_INFO "Crossfire TRT Server" |
362 | #define VERSION_INFO "Deliantra Server" |
410 | |
363 | |
411 | typedef object_vector<client, &client::active> sockvec; |
364 | typedef object_vector<client, &client::active> sockvec; |
412 | |
365 | |
413 | extern sockvec clients; |
366 | extern sockvec clients; |
414 | |
367 | |
415 | #define for_all_clients(var) \ |
368 | #define for_all_clients(var) \ |
416 | for (int _i = 0; _i < clients.size (); ++_i) \ |
369 | for (int _i = 0; _i < clients.size (); ++_i) \ |
417 | statementvar (client *, var, clients [_i]) |
370 | statementvar (client *, var, clients [_i]) |
418 | |
371 | |
|
|
372 | // returns true when the message needs special (read: perl) treatment |
|
|
373 | static inline bool |
|
|
374 | msg_is_special (const char *msg, bool nl_special = true) |
|
|
375 | { |
|
|
376 | return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; |
|
|
377 | } |
|
|
378 | |
419 | #endif |
379 | #endif |
420 | |
380 | |