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.87 by root, Mon Oct 12 14:00:58 2009 UTC vs.
Revision 1.112 by root, Sun Nov 11 05:53:12 2012 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 (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 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 it under 6 * Deliantra is free software: you can redistribute it and/or modify it under
9 * the terms of the Affero GNU General Public License as published by the 7 * the terms of the Affero GNU General Public License as published by the
10 * Free Software Foundation, either version 3 of the License, or (at your 8 * Free Software Foundation, either version 3 of the License, or (at your
11 * 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 Affero GNU General Public License 16 * You should have received a copy of the Affero GNU General Public License
19 * and the GNU General Public License along with this program. If not, see 17 * and the GNU General Public License along with this program. If not, see
20 * <http://www.gnu.org/licenses/>. 18 * <http://www.gnu.org/licenses/>.
21 * 19 *
22 * 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>
23 */ 21 */
24 22
25#ifndef CLIENT_H 23#ifndef CLIENT_H
26#define CLIENT_H 24#define CLIENT_H
27
28#include <deque>
29#include <bitset>
30#include <tr1/unordered_set>
31 25
32#if HAVE_TCP_INFO 26#if HAVE_TCP_INFO
33# include <netinet/tcp.h> 27# include <netinet/tcp.h>
34#else 28#else
35 struct tcp_info { 29 struct tcp_info {
64 int tcpi_advmss; 58 int tcpi_advmss;
65 int tcpi_reordering; 59 int tcpi_reordering;
66 }; 60 };
67#endif 61#endif
68 62
63//+GPL
64
69// (possibly) max. number of objects "per page" in the ground container 65// (possibly) max. number of objects "per page" in the ground container
70#define FLOORBOX_PAGESIZE 50 66#define FLOORBOX_PAGESIZE 50
71 67
72struct MapCell 68struct MapCell
73{ 69{
93struct statsinfo 89struct statsinfo
94{ 90{
95 char *range, *title; 91 char *range, *title;
96}; 92};
97 93
98/* This contains basic information on the socket structure. status is its
99 * current state. we set up our on buffers for sending/receiving, so we can
100 * handle some higher level functions. fd is the actual file descriptor we
101 * are using.
102 */
103
104/* Only one map mode can actually be used, so lets make it a switch
105 * instead of having a bunch of different fields that needed to
106 * get toggled.
107 */
108enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
109
110// states the socket can be in 94// states the socket can be in
111enum { 95enum {
112 ST_DEAD, // socket is dead 96 ST_DEAD, // socket is dead
113 ST_SETUP, // initial handshake / setup / login 97 ST_SETUP, // initial handshake / setup / login
114 ST_PLAYING, // logged in an playing 98 ST_PLAYING, // logged in an playing
123 PF_PLAYING = 0x02, // must be in playing state 107 PF_PLAYING = 0x02, // must be in playing state
124 PF_COMMAND0 = 0x04, // command starts at offset 0 108 PF_COMMAND0 = 0x04, // command starts at offset 0
125 PF_COMMAND6 = 0x08, // command starts at offset 6 109 PF_COMMAND6 = 0x08, // command starts at offset 6
126}; 110};
127 111
128// face type.s bit 0 means "has meta info prepended" 112// face types. bit 0 means "has meta info prepended"
129enum { 113enum {
130 FT_FACE = 0 * 2 + 0, // faces (images) 114 FT_IMAGE = 0 * 2 + 0, // images
131 FT_MUSIC = 1 * 2 + 1, // background music 115 FT_MUSIC = 1 * 2 + 1, // background music
132 FT_SOUND = 2 * 2 + 1, // effects 116 FT_SOUND = 2 * 2 + 1, // effects
133 FT_RSRC = 3 * 2 + 0, // generic data files 117 FT_RSRC = 3 * 2 + 0, // generic data files
134 FT_NUM, 118 FT_NUM,
135}; 119};
147 const packet_type *handler; 131 const packet_type *handler;
148 char *data; 132 char *data;
149 int datalen; 133 int datalen;
150}; 134};
151 135
136//-GPL
137
152/* 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. */
153#define MAX_PASSWORD_FAILURES 5 139#define MAX_PASSWORD_FAILURES 5
154 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 */
155INTERFACE_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
156struct client : zero_initialised, attachable 147struct client : zero_initialised, attachable
157{ 148{
158 int ACC (RW, fd); 149 int ACC (RW, fd);
159 unsigned int inbuf_len; // number of bytes valid in inbuf 150 unsigned int inbuf_len; // number of bytes valid in inbuf
173 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 */
174 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 */
175 living ACC (RO, last_stats); /* Last stats as sent to client */ 166 living ACC (RO, last_stats); /* Last stats as sent to client */
176 float ACC (RW, last_speed); /* Last speed as sent to client */ 167 float ACC (RW, last_speed); /* Last speed as sent to client */
177 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 */
178 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 */
179 170
180 bool ACC (RW, afk); /* player is afk */ 171 bool ACC (RW, afk); /* player is afk */
181 bool ACC (RW, sent_scroll); 172 bool ACC (RW, sent_scroll);
182 bool ACC (RW, sound); /* does the client want sound */ 173 bool ACC (RW, sound); /* does the client want sound */
183 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 174 bool ACC (RW, bumpmsg); /* give message when bumping into walls */
175
184 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 176 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
185 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
186 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
187 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
188 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 */
189 /* used to arrange text in books, scrolls, or scripted dialogs */
190 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 184 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
185
191 bool ACC (RW, smoothing); // deliantra-style smoothing 186 bool ACC (RW, smoothing); // deliantra-style smoothing
192
193 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
194 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
195 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
196 uint16 ACC (RW, look_position); /* start of drawing of look window */ 188 uint16 ACC (RW, look_position); /* start of drawing of look window */
197 uint16 ACC (RW, mss); // likely tcp maximum segment size 189 uint16 ACC (RW, mss); // likely tcp maximum segment size
198 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
199 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 */
200 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
201 194
202 maptile_ptr ACC (RW, current_map); // CF+ last/current player map 195 maptile_ptr ACC (RW, current_map); // last/current player map
203 region_ptr ACC (RW, current_region); // CF+ last/current player region 196 region_ptr ACC (RW, current_region); // last/current player region
204 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
205 shstr ACC (RW, version); // CF+ client name/version
206 uint8 ACC (RW, faceset); // CF+ selected faceset
207 198
208 tstamp ACC (RW, last_send); // last data send on socket. 199 tstamp ACC (RW, last_send); // last data send on socket.
209 200
210 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 */
211 int ACC (RW, rate_avail); // current rate balance 202 int ACC (RW, rate_avail); // current rate balance
214 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
215 206
216 struct tcp_info tcpi; 207 struct tcp_info tcpi;
217 tstamp next_rate_adjust; 208 tstamp next_rate_adjust;
218 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
219 unordered_vector<char *> mapinfo_queue; 216 unordered_vector<char *> mapinfo_queue;
220 void mapinfo_queue_clear (); 217 void mapinfo_queue_clear ();
221 void mapinfo_queue_run (); 218 void mapinfo_queue_run ();
222 bool mapinfo_try (char *buf); 219 bool mapinfo_try (char *buf);
223 220
224 struct ixsend { 221 struct ixsend {
225 int16_t pri; // unused 222 sint16 pri; // higher means faces are sent earlier, default 0
226 faceidx idx; 223 faceidx idx;
227 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;
228 }; 227 };
229 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
230 231
231 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
232 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 ();
233 237
234 void do_destroy (); 238 void do_destroy ();
235 void gather_callbacks (AV *&callbacks, event_type event) const; 239 void gather_callbacks (AV *&callbacks, event_type event) const;
236 240
237 iow socket_ev; void socket_cb (iow &w, int revents); 241 iow socket_ev; void socket_cb (iow &w, int revents);
245 std::bitset<FT_NUM> fx_want; 249 std::bitset<FT_NUM> fx_want;
246 250
247 // 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.
248 // 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
249 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 253 uint8 inbuf[MAXSOCKBUF + 2 + 1];
254 void inbuf_handle ();
250 255
251 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; 256 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
252 struct msg_buf 257 struct msg_buf
253 { 258 {
254 tick_t expire; 259 tick_t expire;
255 int len; 260 int len;
256 int count; 261 int count;
257 char msg[MSG_BUF_SIZE]; 262 char msg[MSG_BUF_SIZE];
258 } msgbuf[MSG_BUF_COUNT]; 263 } msgbuf[MSG_BUF_COUNT];
259 264
260 MTH bool msg_suppressed (const char *msg); 265 MTH bool msg_suppressed (const_utf8_string msg);
261 266
262 /* 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
263 * data that the OS can't handle right away. 268 * data that the OS can't handle right away.
264 * TODO: this member is enourmously large - optimise? 269 * TODO: this member is enourmously large - optimise?
265 */ 270 */
285 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
286 291
287 MTH void flush (); 292 MTH void flush ();
288 MTH void write_outputbuffer (); 293 MTH void write_outputbuffer ();
289 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
290 void send (void *buf_, int len); 297 void send (void *buf_, int len);
291
292 void send_packet (const char *buf); 298 void send_packet (const_octet_string buf);
293 void send_packet (const char *buf, int len); 299 void send_packet (const_octet_string buf, int len);
294 void send_packet_printf (const char *format, ...); 300 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
295 void send_packet (packet &sl); 301 void send_packet (packet &sl);
296 302
297 void send_drawinfo (const char *msg, int flags = NDI_BLACK); 303 void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK);
298 304
299 MTH void send_face (faceidx facenum, int pri = 0); 305 MTH void send_face (faceidx facenum, int pri = 0);
300 MTH void send_faces (object *ob); 306 MTH void send_faces (object *ob);
301 MTH void send_animation (short anim_num); 307 MTH void send_animation (short anim_num);
302 void send_msg (int color, const char *type, const char *msg); 308 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
303 309
304 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); 310 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
305 // called when something under the player changes 311 // called when something under the player changes
306 MTH void floorbox_update () { update_look = 1; } 312 MTH void floorbox_update () { update_look = 1; }
307 // called when the player has been moved 313 // called when the player has been moved
310 MTH void tick (); // called every server tick to do housekeeping etc. 316 MTH void tick (); // called every server tick to do housekeeping etc.
311 317
312 MTH static client *create (int fd, const char *peername); 318 MTH static client *create (int fd, const char *peername);
313 MTH static void clock (); 319 MTH static void clock ();
314 MTH static void flush_sockets (); 320 MTH static void flush_sockets ();
321
322 MTH void run (); // start handshake after init
315 323
316protected: 324protected:
317 client (int fd, const char *from_ip); 325 client (int fd, const char *from_ip);
318 ~client (); 326 ~client ();
319}; 327};
348 ACC (RW, tcpi.tcpi_snd_cwnd); 356 ACC (RW, tcpi.tcpi_snd_cwnd);
349 ACC (RW, tcpi.tcpi_advmss); 357 ACC (RW, tcpi.tcpi_advmss);
350 ACC (RW, tcpi.tcpi_reordering); 358 ACC (RW, tcpi.tcpi_reordering);
351#endif 359#endif
352 360
353#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
354 ( ((__type)>0) &&\
355 ((__sockPtr)->has_readable_type) && \
356 ((__sockPtr)->supported_readables & (1<<(__type))) )
357
358#define FACE_TYPES 1
359#define PNG_FACE_INDEX 0
360
361#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
362#define VERSION_SC 1026
363//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
364#define VERSION_INFO "Deliantra Server"
365
366typedef object_vector<client, &client::active> sockvec; 361typedef object_vector<client, &client::active> sockvec;
367 362
368extern sockvec clients; 363extern sockvec clients;
369 364
370#define for_all_clients(var) \ 365#define for_all_clients(var) \
371 for (int _i = 0; _i < clients.size (); ++_i) \ 366 for (int _i = 0; _i < clients.size (); ++_i) \
372 statementvar (client *, var, clients [_i]) 367 statementvar (client *, var, clients [_i])
373 368
374// returns true when the message needs special (read: perl) treatment 369// returns true when the message needs special (read: perl) treatment
375static inline bool 370static inline bool
376msg_is_special (const char *msg, bool nl_special = true) 371msg_is_special (const_any_string msg, bool nl_special = true)
377{ 372{
378 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")]; 373 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
379} 374}
380 375
381#endif 376#endif

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines