ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/client.h
(Generate patch)

Comparing deliantra/server/include/client.h (file contents):
Revision 1.86 by root, Wed Sep 2 16:54:20 2009 UTC vs.
Revision 1.121 by root, Sat Nov 17 23:40:00 2018 UTC

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 (©) 2017,2018 Marc Alexander Lehmann / the Deliantra team
4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / 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
5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 * 6 *
8 * Deliantra is free software: you can redistribute it and/or modify 7 * 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 8 * 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 9 * Free Software Foundation, either version 3 of the License, or (at your
11 * (at your option) any later version. 10 * option) any later version.
12 * 11 *
13 * This program is distributed in the hope that it will be useful, 12 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details. 15 * GNU General Public License for more details.
17 * 16 *
18 * You should have received a copy of the GNU General Public License 17 * 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/>. 18 * and the GNU General Public License along with this program. If not, see
19 * <http://www.gnu.org/licenses/>.
20 * 20 *
21 * The authors can be reached via e-mail to <support@deliantra.net> 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
27#include <deque>
28#include <bitset>
29#include <tr1/unordered_set>
30 26
31#if HAVE_TCP_INFO 27#if HAVE_TCP_INFO
32# include <netinet/tcp.h> 28# include <netinet/tcp.h>
33#else 29#else
34 struct tcp_info { 30 struct tcp_info {
63 int tcpi_advmss; 59 int tcpi_advmss;
64 int tcpi_reordering; 60 int tcpi_reordering;
65 }; 61 };
66#endif 62#endif
67 63
64//+GPL
65
68// (possibly) max. number of objects "per page" in the ground container 66// (possibly) max. number of objects "per page" in the ground container
69#define FLOORBOX_PAGESIZE 50 67#define FLOORBOX_PAGESIZE 50
70 68
71struct MapCell 69struct MapCell
72{ 70{
92struct statsinfo 90struct statsinfo
93{ 91{
94 char *range, *title; 92 char *range, *title;
95}; 93};
96 94
97/* 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
99 * handle some higher level functions. fd is the actual file descriptor we
100 * are using.
101 */
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 */
107enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
108
109// states the socket can be in 95// states the socket can be in
110enum { 96enum {
111 ST_DEAD, // socket is dead 97 ST_DEAD, // socket is dead
112 ST_SETUP, // initial handshake / setup / login 98 ST_SETUP, // initial handshake / setup / login
113 ST_PLAYING, // logged in an playing 99 ST_PLAYING, // logged in an playing
116 ST_GET_PARTY_PASSWORD, 102 ST_GET_PARTY_PASSWORD,
117}; 103};
118 104
119// a handler for a specific type of packet 105// a handler for a specific type of packet
120enum { 106enum {
121 PF_PLAYER = 0x01, // must have valid player / will by synchronised 107 PF_PLAYER = 0x01, // must have valid player / will by synchronised
122 PF_PLAYING = 0x02, // must be in playing state 108 PF_PLAYING = 0x02, // must be in playing state
123 PF_COMMAND0 = 0x04, // command starts at offset 0 109 PF_COMMAND = 0x04, // is a user command
124 PF_COMMAND6 = 0x08, // command starts at offset 6
125}; 110};
126 111
127// face type.s bit 0 means "has meta info prepended" 112// face types. bit 0 means "has meta info prepended"
128enum { 113enum {
129 FT_FACE = 0 * 2 + 0, // faces (images) 114 FT_IMAGE = 0 * 2 + 0, // images
130 FT_MUSIC = 1 * 2 + 1, // background music 115 FT_MUSIC = 1 * 2 + 1, // background music
131 FT_SOUND = 2 * 2 + 1, // effects 116 FT_SOUND = 2 * 2 + 1, // effects
132 FT_RSRC = 3 * 2 + 0, // generic data files 117 FT_RSRC = 3 * 2 + 0, // generic data files
133 FT_NUM, 118 FT_NUM,
134}; 119};
146 const packet_type *handler; 131 const packet_type *handler;
147 char *data; 132 char *data;
148 int datalen; 133 int datalen;
149}; 134};
150 135
136//-GPL
137
151/* how many times we are allowed to give the wrong password before being kicked. */ 138/* how many times we are allowed to give the wrong password before being kicked. */
152#define MAX_PASSWORD_FAILURES 5 139#define MAX_PASSWORD_FAILURES 5
153 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 */
154INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 146INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
155struct client : zero_initialised, attachable 147struct client : zero_initialised, attachable
156{ 148{
157 int ACC (RW, fd); 149 int ACC (RW, fd);
158 unsigned int inbuf_len; // number of bytes valid in inbuf 150 unsigned int inbuf_len; // number of bytes valid in inbuf
159 statsinfo stats; 151 statsinfo stats;
160 object_vector_index ACC (RO, active); 152 object_vector_index ACC (RO, active);
161 player_ptr ACC (RO, pl); 153 player_ptr ACC (RO, pl);
162 154
163 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 155 char *ACC (RW, host); /* Which host it is connected from (ip:port) */
164 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ 156 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
165 157
166 sint8 ACC (RW, last_level); /* Last level we sent to client */ 158 sint8 ACC (RW, last_level); /* Last level we sent to client */
167 uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */ 159 uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
168 float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */ 160 float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
172 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ 164 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 */ 165 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
174 living ACC (RO, last_stats); /* Last stats as sent to client */ 166 living ACC (RO, last_stats); /* Last stats as sent to client */
175 float ACC (RW, last_speed); /* Last speed as sent to client */ 167 float ACC (RW, last_speed); /* Last speed as sent to client */
176 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ 168 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 */ 169 sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */
178 170
179 bool ACC (RW, afk); /* player is afk */ 171 bool ACC (RW, afk); /* player is afk */
180 bool ACC (RW, sent_scroll); 172 bool ACC (RW, sent_scroll);
181 bool ACC (RW, sound); /* does the client want sound */ 173 bool ACC (RW, sound); /* does the client want sound */
182 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 174 bool ACC (RW, bumpmsg); /* give message when bumping into walls */
175
183 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 176 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
184 bool ACC (RW, mapinfocmd); // return map info and send map change info 177 bool ACC (RW, mapinfocmd); // return map info and send map change info
185 uint8_t ACC (RW, extcmd); // call into extensions/plugins 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
186 bool ACC (RW, update_look); /* If true, we need to send the look window */ 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
187 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 183 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
188 /* used to arrange text in books, scrolls, or scripted dialogs */
189 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 184 uint8 ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
185
190 bool ACC (RW, smoothing); // deliantra-style smoothing 186 bool ACC (RW, smoothing); // deliantra-style smoothing
191
192 bool ACC (RW, force_newmap); // force a newmap before next map update 187 bool ACC (RW, force_newmap); // force a newmap before next map update
193 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
194 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
195 uint16 ACC (RW, look_position); /* start of drawing of look window */ 188 uint16 ACC (RW, look_position); /* start of drawing of look window */
196 uint16 ACC (RW, mss); // likely tcp maximum segment size 189 uint16 ACC (RW, mss); // likely tcp maximum segment size
197 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
198 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 190 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
199 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 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
200 194
201 maptile_ptr ACC (RW, current_map); // CF+ last/current player map 195 maptile_ptr ACC (RW, current_map); // last/current player map
202 region_ptr ACC (RW, current_region); // CF+ last/current player region 196 region_ptr ACC (RW, current_region); // last/current player region
203 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
204 shstr ACC (RW, version); // CF+ client name/version
205 uint8 ACC (RW, faceset); // CF+ selected faceset
206 198
207 tstamp ACC (RW, last_send); // last data send on socket. 199 tstamp ACC (RW, last_send); // last data send on socket.
208 200
209 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */ 201 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
210 int ACC (RW, rate_avail); // current rate balance 202 int ACC (RW, rate_avail); // current rate balance
213 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
214 206
215 struct tcp_info tcpi; 207 struct tcp_info tcpi;
216 tstamp next_rate_adjust; 208 tstamp next_rate_adjust;
217 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
218 unordered_vector<char *> mapinfo_queue; 216 unordered_vector<char *> mapinfo_queue;
219 void mapinfo_queue_clear (); 217 void mapinfo_queue_clear ();
220 void mapinfo_queue_run (); 218 void mapinfo_queue_run ();
221 bool mapinfo_try (char *buf); 219 bool mapinfo_try (char *buf);
222 220
223 struct ixsend { 221 struct ixsend {
224 int16_t pri; // unused 222 sint16 pri; // higher means faces are sent earlier, default 0
225 faceidx idx; 223 faceidx idx;
226 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face 224 uint32 ofs; // if != 0, need to send remaining bytes of partial_face
225 uint8 *data;
226 SV *data_sv;
227 }; 227 };
228 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix 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
229 231
230 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx 232 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
231 MTH void flush_fx (); // send fx if required 233 MTH void flush_fx (); // send fx if required
234
235 MTH void invalidate_face (faceidx idx);
236 MTH void invalidate_all_faces ();
232 237
233 void do_destroy (); 238 void do_destroy ();
234 void gather_callbacks (AV *&callbacks, event_type event) const; 239 void gather_callbacks (AV *&callbacks, event_type event) const;
235 240
236 iow socket_ev; void socket_cb (iow &w, int revents); 241 iow socket_ev; void socket_cb (iow &w, int revents);
244 std::bitset<FT_NUM> fx_want; 249 std::bitset<FT_NUM> fx_want;
245 250
246 // if we get an incomplete packet, this is used to hold the data. 251 // if we get an incomplete packet, this is used to hold the data.
247 // we add 2 byte for the header, one for the trailing 0 byte 252 // we add 2 byte for the header, one for the trailing 0 byte
248 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 253 uint8 inbuf[MAXSOCKBUF + 2 + 1];
254 void inbuf_handle ();
249 255
250 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; 256 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
251 struct msg_buf 257 struct msg_buf
252 { 258 {
253 tick_t expire; 259 tick_t expire;
254 int len; 260 int len;
255 int count; 261 int count;
256 char msg[MSG_BUF_SIZE]; 262 char msg[MSG_BUF_SIZE];
257 } msgbuf[MSG_BUF_COUNT]; 263 } msgbuf[MSG_BUF_COUNT];
258 264
259 MTH bool msg_suppressed (const char *msg); 265 MTH bool msg_suppressed (const_utf8_string msg);
260 266
261 /* The following is the setup for a ring buffer for storing output 267 /* The following is the setup for a ring buffer for storing output
262 * data that the OS can't handle right away. 268 * data that the OS can't handle right away.
263 * TODO: this member is enourmously large - optimise? 269 * TODO: this member is enourmously large - optimise?
264 */ 270 */
284 void skip_packet (int len); // we have processed the packet, skip it 290 void skip_packet (int len); // we have processed the packet, skip it
285 291
286 MTH void flush (); 292 MTH void flush ();
287 MTH void write_outputbuffer (); 293 MTH void write_outputbuffer ();
288 MTH int outputbuffer_len () const { return outputbuffer.len; } 294 MTH int outputbuffer_len () const { return outputbuffer.len; }
295 void send_raw (void *buf_, int len);
296
289 void send (void *buf_, int len); 297 void send (void *buf_, int len);
290
291 void send_packet (const char *buf); 298 void send_packet (const_octet_string buf);
292 void send_packet (const char *buf, int len); 299 void send_packet (const_octet_string buf, int len);
293 void send_packet_printf (const char *format, ...); 300 void send_packet_printf (const_utf8_string format, ...) ecb_attribute ((format (printf, 2, 3)));
294 void send_packet (packet &sl); 301 void send_packet (packet &sl);
295
296 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
297 302
298 MTH void send_face (faceidx facenum, int pri = 0); 303 MTH void send_face (faceidx facenum, int pri = 0);
299 MTH void send_faces (object *ob); 304 MTH void send_faces (object *ob);
300 MTH void send_animation (short anim_num); 305 MTH void send_animation (short anim_num);
301 void send_msg (int color, const char *type, const char *msg); 306 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
302 307
303 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); 308 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
304 // called when something under the player changes 309 // called when something under the player changes
305 MTH void floorbox_update () { update_look = 1; } 310 MTH void floorbox_update () { update_look = 1; }
306 // called when the player has been moved 311 // called when the player has been moved
309 MTH void tick (); // called every server tick to do housekeeping etc. 314 MTH void tick (); // called every server tick to do housekeeping etc.
310 315
311 MTH static client *create (int fd, const char *peername); 316 MTH static client *create (int fd, const char *peername);
312 MTH static void clock (); 317 MTH static void clock ();
313 MTH static void flush_sockets (); 318 MTH static void flush_sockets ();
319
320 MTH void run (); // start handshake after init
314 321
315protected: 322protected:
316 client (int fd, const char *from_ip); 323 client (int fd, const char *from_ip);
317 ~client (); 324 ~client ();
318}; 325};
347 ACC (RW, tcpi.tcpi_snd_cwnd); 354 ACC (RW, tcpi.tcpi_snd_cwnd);
348 ACC (RW, tcpi.tcpi_advmss); 355 ACC (RW, tcpi.tcpi_advmss);
349 ACC (RW, tcpi.tcpi_reordering); 356 ACC (RW, tcpi.tcpi_reordering);
350#endif 357#endif
351 358
352#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
353 ( ((__type)>0) &&\
354 ((__sockPtr)->has_readable_type) && \
355 ((__sockPtr)->supported_readables & (1<<(__type))) )
356
357#define FACE_TYPES 1
358#define PNG_FACE_INDEX 0
359
360#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
361#define VERSION_SC 1026
362//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
363#define VERSION_INFO "Deliantra Server"
364
365typedef object_vector<client, &client::active> sockvec; 359typedef object_vector<client, &client::active> sockvec;
366 360
367extern sockvec clients; 361extern sockvec clients;
368 362
369#define for_all_clients(var) \ 363#define for_all_clients(var) \
370 for (int _i = 0; _i < clients.size (); ++_i) \ 364 for (int _i = 0; _i < clients.size (); ++_i) \
371 statementvar (client *, var, clients [_i]) 365 statementvar (client *, var, clients [_i])
372 366
373// returns true when the message needs special (read: perl) treatment 367// returns true when the message needs special (read: perl) treatment
374static inline bool 368static inline bool
375msg_is_special (const char *msg, bool nl_special = true) 369msg_is_special (const_any_string msg, bool nl_special = true)
376{ 370{
377 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; 371 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
378} 372}
379 373
380#endif 374#endif
381 375

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines