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.79 by root, Mon Jul 14 23:47:06 2008 UTC vs.
Revision 1.115 by root, Wed Nov 21 13:22:34 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 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
71struct MapCell 68struct MapCell
72{ 69{
… …
92struct statsinfo 89struct statsinfo
93{ 90{
94 char *range, *title; 91 char *range, *title;
95}; 92};
96 93
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 94// states the socket can be in
110enum { 95enum {
111 ST_DEAD, // socket is dead 96 ST_DEAD, // socket is dead
112 ST_SETUP, // initial handshake / setup / login 97 ST_SETUP, // initial handshake / setup / login
113 ST_PLAYING, // logged in an playing 98 ST_PLAYING, // logged in an playing
… …
116 ST_GET_PARTY_PASSWORD, 101 ST_GET_PARTY_PASSWORD,
117}; 102};
118 103
119// a handler for a specific type of packet 104// a handler for a specific type of packet
120enum { 105enum {
121 PF_PLAYER = 0x01, // must have valid player / will by synchronised 106 PF_PLAYER = 0x01, // must have valid player / will by synchronised
122 PF_PLAYING = 0x02, // must be in playing state 107 PF_PLAYING = 0x02, // must be in playing state
123 PF_COMMAND0 = 0x04, // command starts at offset 0 108 PF_COMMAND = 0x04, // is a suer command
124 PF_COMMAND6 = 0x08, // command starts at offset 6
125}; 109};
126 110
127// face type.s bit 0 means "has meta info prepended" 111// face types. bit 0 means "has meta info prepended"
128enum { 112enum {
129 FT_FACE = 0 * 2 + 0, // faces (images) 113 FT_IMAGE = 0 * 2 + 0, // images
130 FT_MUSIC = 1 * 2 + 1, // background music 114 FT_MUSIC = 1 * 2 + 1, // background music
131 FT_SOUND = 2 * 2 + 1, // effects 115 FT_SOUND = 2 * 2 + 1, // effects
132 FT_RSRC = 3 * 2 + 0, // generic data files 116 FT_RSRC = 3 * 2 + 0, // generic data files
133 FT_NUM, 117 FT_NUM,
134}; 118};
… …
146 const packet_type *handler; 130 const packet_type *handler;
147 char *data; 131 char *data;
148 int datalen; 132 int datalen;
149}; 133};
150 134
135//-GPL
136
151/* how many times we are allowed to give the wrong password before being kicked. */ 137/* how many times we are allowed to give the wrong password before being kicked. */
152#define MAX_PASSWORD_FAILURES 5 138#define MAX_PASSWORD_FAILURES 5
153 139
140/* This contains basic information on the socket connection. status is its
141 * current state. we set up our on buffers for sending/receiving, so we can
142 * handle some higher level functions. fd is the actual file descriptor we
143 * are using.
144 */
154INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player 145INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
155struct client : zero_initialised, attachable 146struct client : zero_initialised, attachable
156{ 147{
157 int ACC (RW, fd); 148 int ACC (RW, fd);
158 unsigned int inbuf_len; // number of bytes valid in inbuf 149 unsigned int inbuf_len; // number of bytes valid in inbuf
159 statsinfo stats; 150 statsinfo stats;
160 object_vector_index ACC (RO, active); 151 object_vector_index ACC (RO, active);
161 player_ptr ACC (RO, pl); 152 player_ptr ACC (RO, pl);
162
163 /* The following is the setup for a ring buffer for storing output
164 * data that the OS can't handle right away.
165 */
166 struct
167 {
168 char data[SOCKETBUFSIZE];
169 int start;
170 int len;
171 } outputbuffer;
172 153
173 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 154 char *ACC (RW, host); /* Which host it is connected from (ip address) */
174 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ 155 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
175 156
176 sint8 ACC (RW, last_level); /* Last level we sent to client */ 157 sint8 ACC (RW, last_level); /* Last level we sent to client */
… …
182 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */ 163 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
183 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */ 164 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
184 living ACC (RO, last_stats); /* Last stats as sent to client */ 165 living ACC (RO, last_stats); /* Last stats as sent to client */
185 float ACC (RW, last_speed); /* Last speed as sent to client */ 166 float ACC (RW, last_speed); /* Last speed as sent to client */
186 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */ 167 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
187 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */ 168 sint64 ACC (RW, last_skill_exp[CS_NUM_SKILLS]);/* shadow register. if != exp. obj update client */
188
189 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
190 bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
191 bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
192 bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
193 169
194 bool ACC (RW, afk); /* player is afk */ 170 bool ACC (RW, afk); /* player is afk */
195 bool ACC (RW, facecache); /* If true, client is caching images */
196 bool ACC (RW, sent_scroll); 171 bool ACC (RW, sent_scroll);
197 bool ACC (RW, sound); /* does the client want sound */ 172 bool ACC (RW, sound); /* does the client want sound */
198 bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ 173 bool ACC (RW, bumpmsg); /* give message when bumping into walls */
174
199 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ 175 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
200 bool ACC (RW, mapinfocmd); // return map info and send map change info 176 bool ACC (RW, mapinfocmd); // return map info and send map change info
201 uint8_t ACC (RW, extcmd); // call into extensions/plugins 177 uint8 ACC (RW, extcmd); // call into extensions/plugins
202 bool ACC (RW, extmap); // extend map comamnd with extra data 178 bool ACC (RW, need_delinv0); /* If true, we need to delinv 0 before sending new floorbox */
203 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls 179
204 bool ACC (RW, darkness); /* True if client wants darkness information */
205 bool ACC (RW, image2); /* Client wants image2/face2 commands */
206 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
207 bool ACC (RW, update_look); /* If true, we need to send the look window */ 180 bool ACC (RW, update_look); /* If true, we need to send the look window */
181 bool ACC (RW, update_spells); // If true, we need to esrv_update_spells
208 bool ACC (RW, has_readable_type); /* If true client accept additional text information */ 182 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
209 /* used to arrange text in books, scrolls, or scripted dialogs */
210 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 183 uint8 ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
211 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ 184
212 /* Below are flags for extedend infos to pass to client
213 * with S->C mapextended command */
214 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
215 bool ACC (RW, smoothing); // trt-style smoothing 185 bool ACC (RW, smoothing); // deliantra-style smoothing
216 bool ACC (RW, can_msg); // trt-style text messages
217
218 bool ACC (RW, force_newmap); // force a newmap before next map update 186 bool ACC (RW, force_newmap); // force a newmap before next map update
219 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
220 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
221 uint16 ACC (RW, look_position); /* start of drawing of look window */ 187 uint16 ACC (RW, look_position); /* start of drawing of look window */
222 uint16 ACC (RW, mss); // likely tcp maximum segment size 188 uint16 ACC (RW, mss); // likely tcp maximum segment size
223 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
224 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 189 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
225 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ 190 uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
191 uint8 ACC (RW, tileset); // selected tileset
192 uint8 ACC (RW, ws_version); // websocket protocol versio for framing
226 193
227 maptile *ACC (RW, current_map); // CF+ last/current player map 194 maptile_ptr ACC (RW, current_map); // last/current player map
228 region *ACC (RW, current_region); // CF+ last/current player region 195 region_ptr ACC (RW, current_region); // last/current player region
229 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position 196 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
230 shstr ACC (RW, version); // CF+ client name/version
231 uint8 ACC (RW, faceset); // CF+ selected faceset
232 197
233 tstamp ACC (RW, last_send); // last data send on socket. 198 tstamp ACC (RW, last_send); // last data send on socket.
234 199
200 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
235 int ACC (RW, rate_avail); // current rate balance 201 int ACC (RW, rate_avail); // current rate balance
236 int ACC (RW, max_rate); // max. # of bytes to send per tick 202 int ACC (RW, max_rate); // max. # of bytes to send per tick
237 faceidx ACC (RW, scrub_idx); // which face to send next 203 faceidx ACC (RW, scrub_idx); // which face to send next
238 int ACC (RW, bg_scrub); // how many ticks till the next background face send 204 int ACC (RW, bg_scrub); // how many ticks till the next background face send
239 205
240 struct tcp_info tcpi; 206 struct tcp_info tcpi;
241 tstamp next_rate_adjust; 207 tstamp next_rate_adjust;
242 208
209 // websocket frame buffer
210 uint8 ws_inbuf_type; // current frame type
211 uint8 *ws_inbuf;
212 uint32 ws_inbuf_len;
213 uint32 ws_inbuf_alloc;
214
243 unordered_vector<char *> mapinfo_queue; 215 unordered_vector<char *> mapinfo_queue;
244 void mapinfo_queue_clear (); 216 void mapinfo_queue_clear ();
245 void mapinfo_queue_run (); 217 void mapinfo_queue_run ();
246 bool mapinfo_try (char *buf); 218 bool mapinfo_try (char *buf);
247 219
248 struct ixsend { 220 struct ixsend {
249 int16_t pri; // unused 221 sint16 pri; // higher means faces are sent earlier, default 0
250 faceidx idx; 222 faceidx idx;
251 uint32_t ofs; // if != 0, need to send remaining bytes of partial_face 223 uint32 ofs; // if != 0, need to send remaining bytes of partial_face
224 uint8 *data;
225 SV *data_sv;
252 }; 226 };
253 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix 227 std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
228 MTH void ix_send (faceidx idx, sint16 pri, SV *data_sv); // keeps a copy of data_sv
229 void ix_pop (); // pops topmost ixsend
254 230
255 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx 231 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
256 MTH void flush_fx (); // send fx if required 232 MTH void flush_fx (); // send fx if required
233
234 MTH void invalidate_face (faceidx idx);
235 MTH void invalidate_all_faces ();
257 236
258 void do_destroy (); 237 void do_destroy ();
259 void gather_callbacks (AV *&callbacks, event_type event) const; 238 void gather_callbacks (AV *&callbacks, event_type event) const;
260 239
261 iow socket_ev; void socket_cb (iow &w, int revents); 240 iow socket_ev; void socket_cb (iow &w, int revents);
… …
269 std::bitset<FT_NUM> fx_want; 248 std::bitset<FT_NUM> fx_want;
270 249
271 // if we get an incomplete packet, this is used to hold the data. 250 // if we get an incomplete packet, this is used to hold the data.
272 // we add 2 byte for the header, one for the trailing 0 byte 251 // we add 2 byte for the header, one for the trailing 0 byte
273 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 252 uint8 inbuf[MAXSOCKBUF + 2 + 1];
253 void inbuf_handle ();
274 254
275 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 }; 255 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
276 struct msg_buf 256 struct msg_buf
277 { 257 {
278 tick_t expire; 258 tick_t expire;
279 int len; 259 int len;
280 int count; 260 int count;
281 char msg[MSG_BUF_SIZE]; 261 char msg[MSG_BUF_SIZE];
282 } msgbuf[MSG_BUF_COUNT]; 262 } msgbuf[MSG_BUF_COUNT];
283 263
284 MTH bool msg_suppressed (const char *msg); 264 MTH bool msg_suppressed (const_utf8_string msg);
265
266 /* The following is the setup for a ring buffer for storing output
267 * data that the OS can't handle right away.
268 * TODO: this member is enourmously large - optimise?
269 */
270 struct
271 {
272 char data[SOCKETBUFSIZE];
273 int start;
274 int len;
275 } outputbuffer;
285 276
286 bool may_execute (const packet_type *pkt) const; 277 bool may_execute (const packet_type *pkt) const;
287 void execute (const packet_type *pkt, char *data, int datalen); 278 void execute (const packet_type *pkt, char *data, int datalen);
288 279
289 void queue_command (packet_type *handler, char *data, int datalen); 280 void queue_command (packet_type *handler, char *data, int datalen);
… …
298 void skip_packet (int len); // we have processed the packet, skip it 289 void skip_packet (int len); // we have processed the packet, skip it
299 290
300 MTH void flush (); 291 MTH void flush ();
301 MTH void write_outputbuffer (); 292 MTH void write_outputbuffer ();
302 MTH int outputbuffer_len () const { return outputbuffer.len; } 293 MTH int outputbuffer_len () const { return outputbuffer.len; }
294 void send_raw (void *buf_, int len);
295
303 void send (void *buf_, int len); 296 void send (void *buf_, int len);
304
305 void send_packet (const char *buf); 297 void send_packet (const_octet_string buf);
306 void send_packet (const char *buf, int len); 298 void send_packet (const_octet_string buf, int len);
307 void send_packet_printf (const char *format, ...); 299 void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
308 void send_packet (packet &sl); 300 void send_packet (packet &sl);
309 301
310 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
311
312 MTH void send_face (faceidx facenum, int pri = 0); 302 MTH void send_face (faceidx facenum, int pri = 0);
313 MTH void send_image (faceidx facenum);
314 MTH void send_faces (object *ob); 303 MTH void send_faces (object *ob);
315 MTH void send_animation (short anim_num); 304 MTH void send_animation (short anim_num);
316 void send_msg (int color, const char *type, const char *msg); 305 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
317 306
318 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0); 307 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
319 // called when something under the player changes 308 // called when something under the player changes
320 MTH void floorbox_update () { update_look = 1; } 309 MTH void floorbox_update () { update_look = 1; }
321 // called when the player has been moved 310 // called when the player has been moved
… …
324 MTH void tick (); // called every server tick to do housekeeping etc. 313 MTH void tick (); // called every server tick to do housekeeping etc.
325 314
326 MTH static client *create (int fd, const char *peername); 315 MTH static client *create (int fd, const char *peername);
327 MTH static void clock (); 316 MTH static void clock ();
328 MTH static void flush_sockets (); 317 MTH static void flush_sockets ();
318
319 MTH void run (); // start handshake after init
329 320
330protected: 321protected:
331 client (int fd, const char *from_ip); 322 client (int fd, const char *from_ip);
332 ~client (); 323 ~client ();
333}; 324};
… …
362 ACC (RW, tcpi.tcpi_snd_cwnd); 353 ACC (RW, tcpi.tcpi_snd_cwnd);
363 ACC (RW, tcpi.tcpi_advmss); 354 ACC (RW, tcpi.tcpi_advmss);
364 ACC (RW, tcpi.tcpi_reordering); 355 ACC (RW, tcpi.tcpi_reordering);
365#endif 356#endif
366 357
367#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
368 ( ((__type)>0) &&\
369 ((__sockPtr)->has_readable_type) && \
370 ((__sockPtr)->supported_readables & (1<<(__type))) )
371
372/* Constants in the form EMI_ is for extended map infos.
373 * Even if the client select the additionnal infos it wants
374 * on the map, there may exist cases where this whole info
375 * is not given in one buch but in separate bunches. This
376 * is done performance reasons (imagine some info related to
377 * a visible object and another info related to a 4 square
378 * width and height area). At the begin of an extended info packet
379 * is a bit field. A bit is activated for each extended info
380 * present in the data
381 */
382
383/* Meanings:
384 * EMI_NOREDRAW Take extended infos into account but don't redraw,
385 * some additionnal datas will follow in a new packet
386 * EMI_SMOOTH Datas about smoothing
387 */
388#define EMI_NOREDRAW 0x01
389#define EMI_SMOOTH 0x02
390
391/* this last one says the bitfield continue un next byte
392 * There may be several on contiguous bytes. So there is 7
393 * actual bits used per byte, and the number of bytes
394 * is not fixed in protocol
395 */
396#define EMI_HASMOREBITS 0x80
397
398#define FACE_TYPES 1
399#define PNG_FACE_INDEX 0
400
401#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
402#define VERSION_SC 1026
403//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
404#define VERSION_INFO "Deliantra Server"
405
406typedef object_vector<client, &client::active> sockvec; 358typedef object_vector<client, &client::active> sockvec;
407 359
408extern sockvec clients; 360extern sockvec clients;
409 361
410#define for_all_clients(var) \ 362#define for_all_clients(var) \
411 for (int _i = 0; _i < clients.size (); ++_i) \ 363 for (int _i = 0; _i < clients.size (); ++_i) \
412 statementvar (client *, var, clients [_i]) 364 statementvar (client *, var, clients [_i])
413 365
414// returns true when the message needs special (read: perl) treatment 366// returns true when the message needs special (read: perl) treatment
415static inline bool 367static inline bool
416msg_is_special (const char *msg, bool nl_special = true) 368msg_is_special (const_any_string msg, bool nl_special = true)
417{ 369{
418 return msg [strcspn (msg, nl_special ? "<[&\n" : "<[&")]; 370 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
419} 371}
420 372
421#endif 373#endif
422 374

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines