ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/client.h
Revision: 1.88
Committed: Tue Nov 3 23:44:21 2009 UTC (14 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.87: +0 -2 lines
Log Message: 
tighten copyright statements for files containing no gpl code whatsoever anymore

File Contents

# User Rev Content
1 root 1.1 /*
2 root 1.69 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 pippijn 1.26 *
4 root 1.77 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 pippijn 1.26 *
6 root 1.87 * Deliantra is free software: you can redistribute it and/or modify it under
7     * the terms of the Affero GNU General Public License as published by the
8     * Free Software Foundation, either version 3 of the License, or (at your
9     * option) any later version.
10 pippijn 1.26 *
11 root 1.59 * This program is distributed in the hope that it will be useful,
12     * but WITHOUT ANY WARRANTY; without even the implied warranty of
13     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14     * GNU General Public License for more details.
15 pippijn 1.26 *
16 root 1.87 * You should have received a copy of the Affero GNU General Public License
17     * and the GNU General Public License along with this program. If not, see
18     * <http://www.gnu.org/licenses/>.
19 root 1.51 *
20 root 1.69 * The authors can be reached via e-mail to <support@deliantra.net>
21 pippijn 1.26 */
22 root 1.1
23     #ifndef CLIENT_H
24     #define CLIENT_H
25    
26 root 1.4 #include <deque>
27 root 1.7 #include <bitset>
28 root 1.13 #include <tr1/unordered_set>
29 root 1.1
30 root 1.65 #if HAVE_TCP_INFO
31     # include <netinet/tcp.h>
32     #else
33 root 1.74 struct tcp_info {
34 root 1.65 // dummy
35 root 1.75 int tcpi_state;
36     int tcpi_ca_state;
37     int tcpi_retransmits;
38     int tcpi_probes;
39     int tcpi_backoff;
40     int tcpi_options;
41     int tcpi_snd_wscale;
42     int tcpi_rcv_wscale;
43     int tcpi_rto;
44     int tcpi_ato;
45     int tcpi_snd_mss;
46     int tcpi_rcv_mss;
47     int tcpi_unacked;
48     int tcpi_sacked;
49     int tcpi_lost;
50     int tcpi_retrans;
51     int tcpi_fackets;
52     int tcpi_last_data_sent;
53     int tcpi_last_ack_sent;
54     int tcpi_last_data_recv;
55     int tcpi_last_ack_recv;
56     int tcpi_pmtu;
57     int tcpi_rcv_ssthresh;
58     int tcpi_rtt;
59     int tcpi_rttvar;
60     int tcpi_snd_ssthresh;
61     int tcpi_snd_cwnd;
62     int tcpi_advmss;
63     int tcpi_reordering;
64 root 1.65 };
65     #endif
66    
67 root 1.4 // (possibly) max. number of objects "per page" in the ground container
68 root 1.11 #define FLOORBOX_PAGESIZE 50
69 root 1.1
70     struct MapCell
71     {
72 root 1.79 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
73 root 1.37 int count; /* This is really darkness in the map1 command */
74 root 1.32 faceidx faces[MAP_LAYERS];
75 root 1.36 unsigned char stat_hp; // health of something in this space, or 0
76 root 1.1 unsigned char flags;
77 root 1.37 uint8_t smooth[MAP_LAYERS];
78 root 1.1 };
79    
80 root 1.33 #define MAX_CLIENT_X MAP_CLIENT_X
81     #define MAX_CLIENT_Y MAP_CLIENT_Y
82 root 1.1
83     struct Map
84     {
85     struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
86     };
87    
88     /* True max is 16383 given current map compaction method */
89 root 1.33 #define MAXANIMNUM 10000
90 root 1.1
91     struct statsinfo
92     {
93     char *range, *title;
94     };
95    
96     /* This contains basic information on the socket structure. status is its
97     * current state. we set up our on buffers for sending/receiving, so we can
98     * handle some higher level functions. fd is the actual file descriptor we
99     * are using.
100     */
101    
102     /* Only one map mode can actually be used, so lets make it a switch
103     * instead of having a bunch of different fields that needed to
104     * get toggled.
105     */
106 root 1.42 enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
107 root 1.1
108 root 1.15 // states the socket can be in
109     enum {
110     ST_DEAD, // socket is dead
111     ST_SETUP, // initial handshake / setup / login
112     ST_PLAYING, // logged in an playing
113     ST_CUSTOM, // waiting for custom reply
114    
115     ST_GET_PARTY_PASSWORD,
116     };
117    
118 root 1.4 // a handler for a specific type of packet
119     enum {
120 root 1.28 PF_PLAYER = 0x01, // must have valid player / will by synchronised
121     PF_PLAYING = 0x02, // must be in playing state
122     PF_COMMAND0 = 0x04, // command starts at offset 0
123     PF_COMMAND6 = 0x08, // command starts at offset 6
124 root 1.4 };
125    
126 root 1.63 // face type.s bit 0 means "has meta info prepended"
127     enum {
128     FT_FACE = 0 * 2 + 0, // faces (images)
129     FT_MUSIC = 1 * 2 + 1, // background music
130     FT_SOUND = 2 * 2 + 1, // effects
131     FT_RSRC = 3 * 2 + 0, // generic data files
132     FT_NUM,
133     };
134    
135 root 1.4 struct packet_type
136     {
137     const char *name;
138     void *cb;
139     int flags;
140     };
141    
142     struct command
143     {
144     tstamp stamp;
145     const packet_type *handler;
146     char *data;
147     int datalen;
148     };
149    
150 root 1.1 /* how many times we are allowed to give the wrong password before being kicked. */
151     #define MAX_PASSWORD_FAILURES 5
152    
153 root 1.21 INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
154     struct client : zero_initialised, attachable
155 root 1.1 {
156     int ACC (RW, fd);
157 root 1.10 unsigned int inbuf_len; // number of bytes valid in inbuf
158 root 1.20 statsinfo stats;
159 root 1.54 object_vector_index ACC (RO, active);
160 root 1.53 player_ptr ACC (RO, pl);
161 root 1.12
162 root 1.10 char *ACC (RW, host); /* Which host it is connected from (ip address) */
163 root 1.15 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
164 root 1.25
165     sint8 ACC (RW, last_level); /* Last level we sent to client */
166     uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
167     float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
168 root 1.76 sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
169 root 1.25 sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
170     uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
171     uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
172     uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
173     living ACC (RO, last_stats); /* Last stats as sent to client */
174     float ACC (RW, last_speed); /* Last speed as sent to client */
175     sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
176     sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
177 root 1.10
178 root 1.20 bool ACC (RW, afk); /* player is afk */
179 root 1.10 bool ACC (RW, sent_scroll);
180     bool ACC (RW, sound); /* does the client want sound */
181     bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
182 root 1.40 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
183     bool ACC (RW, mapinfocmd); // return map info and send map change info
184 root 1.85 uint8_t ACC (RW, extcmd); // call into extensions/plugins
185 root 1.10 bool ACC (RW, update_look); /* If true, we need to send the look window */
186     bool ACC (RW, has_readable_type); /* If true client accept additional text information */
187     /* used to arrange text in books, scrolls, or scripted dialogs */
188     bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
189 root 1.84 bool ACC (RW, smoothing); // deliantra-style smoothing
190 root 1.1
191 root 1.40 bool ACC (RW, force_newmap); // force a newmap before next map update
192 root 1.1 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
193     uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
194     uint16 ACC (RW, look_position); /* start of drawing of look window */
195 root 1.43 uint16 ACC (RW, mss); // likely tcp maximum segment size
196 root 1.42 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
197 root 1.1 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
198     uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
199    
200 root 1.80 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
201     region_ptr ACC (RW, current_region); // CF+ last/current player region
202 root 1.1 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
203 root 1.49 shstr ACC (RW, version); // CF+ client name/version
204 root 1.32 uint8 ACC (RW, faceset); // CF+ selected faceset
205 root 1.1
206 root 1.53 tstamp ACC (RW, last_send); // last data send on socket.
207 root 1.1
208 root 1.86 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
209 root 1.44 int ACC (RW, rate_avail); // current rate balance
210 root 1.38 int ACC (RW, max_rate); // max. # of bytes to send per tick
211 root 1.39 faceidx ACC (RW, scrub_idx); // which face to send next
212     int ACC (RW, bg_scrub); // how many ticks till the next background face send
213 root 1.45
214 root 1.65 struct tcp_info tcpi;
215     tstamp next_rate_adjust;
216 root 1.67
217     unordered_vector<char *> mapinfo_queue;
218     void mapinfo_queue_clear ();
219     void mapinfo_queue_run ();
220     bool mapinfo_try (char *buf);
221 root 1.65
222 root 1.58 struct ixsend {
223     int16_t pri; // unused
224     faceidx idx;
225     uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
226     };
227     std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
228 root 1.45
229 root 1.57 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
230 root 1.45 MTH void flush_fx (); // send fx if required
231 root 1.1
232 root 1.21 void do_destroy ();
233     void gather_callbacks (AV *&callbacks, event_type event) const;
234 root 1.4
235 root 1.70 iow socket_ev; void socket_cb (iow &w, int revents);
236 root 1.1
237 root 1.4 std::deque< command, slice_allocator<command> > cmd_queue;
238    
239 root 1.14 // large structures at the end please
240     struct Map lastmap;
241     std::bitset<MAXANIMNUM> anims_sent;
242 root 1.36 std::bitset<MAX_FACES> faces_sent;
243 root 1.63 std::bitset<FT_NUM> fx_want;
244 root 1.36
245 root 1.14 // if we get an incomplete packet, this is used to hold the data.
246     // we add 2 byte for the header, one for the trailing 0 byte
247     uint8 inbuf[MAXSOCKBUF + 2 + 1];
248    
249 root 1.49 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
250     struct msg_buf
251     {
252     tick_t expire;
253     int len;
254     int count;
255     char msg[MSG_BUF_SIZE];
256     } msgbuf[MSG_BUF_COUNT];
257    
258     MTH bool msg_suppressed (const char *msg);
259    
260 root 1.82 /* 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    
271 root 1.4 bool may_execute (const packet_type *pkt) const;
272     void execute (const packet_type *pkt, char *data, int datalen);
273    
274     void queue_command (packet_type *handler, char *data, int datalen);
275 root 1.22 MTH bool handle_command ();
276 root 1.14 // resets movement state
277 root 1.22 MTH void reset_state ();
278 root 1.25 // resets variable data used to send stat diffs
279     MTH void reset_stats ();
280 root 1.1
281 root 1.22 MTH bool handle_packet ();
282 root 1.4 int next_packet (); // returns length of packet or 0
283 root 1.1 void skip_packet (int len); // we have processed the packet, skip it
284    
285 root 1.22 MTH void flush ();
286     MTH void write_outputbuffer ();
287 root 1.38 MTH int outputbuffer_len () const { return outputbuffer.len; }
288 root 1.1 void send (void *buf_, int len);
289    
290     void send_packet (const char *buf);
291     void send_packet (const char *buf, int len);
292 root 1.4 void send_packet_printf (const char *format, ...);
293 root 1.1 void send_packet (packet &sl);
294 root 1.7
295 root 1.35 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
296 root 1.60
297 root 1.63 MTH void send_face (faceidx facenum, int pri = 0);
298 root 1.35 MTH void send_faces (object *ob);
299     MTH void send_animation (short anim_num);
300 root 1.55 void send_msg (int color, const char *type, const char *msg);
301 root 1.35
302 root 1.64 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
303 root 1.10 // called when something under the player changes
304 root 1.22 MTH void floorbox_update () { update_look = 1; }
305 root 1.10 // called when the player has been moved
306 root 1.22 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
307    
308 root 1.39 MTH void tick (); // called every server tick to do housekeeping etc.
309    
310 root 1.22 MTH static client *create (int fd, const char *peername);
311 root 1.66 MTH static void clock ();
312     MTH static void flush_sockets ();
313 root 1.10
314 root 1.22 protected:
315     client (int fd, const char *from_ip);
316     ~client ();
317 root 1.1 };
318    
319 root 1.67 #if FOR_PERL
320     ACC (RW, tcpi.tcpi_state);
321     ACC (RW, tcpi.tcpi_ca_state);
322     ACC (RW, tcpi.tcpi_retransmits);
323     ACC (RW, tcpi.tcpi_probes);
324     ACC (RW, tcpi.tcpi_backoff);
325     ACC (RW, tcpi.tcpi_options);
326     ACC (RO, tcpi.tcpi_snd_wscale);
327     ACC (RO, tcpi.tcpi_rcv_wscale);
328     ACC (RW, tcpi.tcpi_rto);
329     ACC (RW, tcpi.tcpi_ato);
330     ACC (RW, tcpi.tcpi_snd_mss);
331     ACC (RW, tcpi.tcpi_rcv_mss);
332     ACC (RW, tcpi.tcpi_unacked);
333     ACC (RW, tcpi.tcpi_sacked);
334     ACC (RW, tcpi.tcpi_lost);
335     ACC (RW, tcpi.tcpi_retrans);
336     ACC (RW, tcpi.tcpi_fackets);
337     ACC (RW, tcpi.tcpi_last_data_sent);
338     ACC (RW, tcpi.tcpi_last_ack_sent);
339     ACC (RW, tcpi.tcpi_last_data_recv);
340     ACC (RW, tcpi.tcpi_last_ack_recv);
341     ACC (RW, tcpi.tcpi_pmtu);
342     ACC (RW, tcpi.tcpi_rcv_ssthresh);
343     ACC (RW, tcpi.tcpi_rtt);
344     ACC (RW, tcpi.tcpi_rttvar);
345     ACC (RW, tcpi.tcpi_snd_ssthresh);
346     ACC (RW, tcpi.tcpi_snd_cwnd);
347     ACC (RW, tcpi.tcpi_advmss);
348     ACC (RW, tcpi.tcpi_reordering);
349     #endif
350    
351 root 1.1 #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
352     ( ((__type)>0) &&\
353     ((__sockPtr)->has_readable_type) && \
354     ((__sockPtr)->supported_readables & (1<<(__type))) )
355    
356     #define FACE_TYPES 1
357     #define PNG_FACE_INDEX 0
358    
359     #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
360 root 1.31 #define VERSION_SC 1026
361     //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
362 root 1.69 #define VERSION_INFO "Deliantra Server"
363 root 1.1
364 root 1.24 typedef object_vector<client, &client::active> sockvec;
365 root 1.1
366     extern sockvec clients;
367 root 1.24
368     #define for_all_clients(var) \
369     for (int _i = 0; _i < clients.size (); ++_i) \
370 root 1.52 statementvar (client *, var, clients [_i])
371 root 1.24
372 root 1.78 // 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 root 1.81 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
377 root 1.78 }
378    
379 root 1.1 #endif
380