ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/client.h
Revision: 1.93
Committed: Fri Mar 26 01:04:44 2010 UTC (14 years, 2 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.92: +1 -1 lines
Log Message: 
update copyright for up to 2010

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.93 * Copyright (©) 2005,2006,2007,2008,2009,2010 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.89 //+GPL
68    
69 root 1.4 // (possibly) max. number of objects "per page" in the ground container
70 root 1.11 #define FLOORBOX_PAGESIZE 50
71 root 1.1
72     struct MapCell
73     {
74 root 1.79 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
75 root 1.37 int count; /* This is really darkness in the map1 command */
76 root 1.32 faceidx faces[MAP_LAYERS];
77 root 1.36 unsigned char stat_hp; // health of something in this space, or 0
78 root 1.1 unsigned char flags;
79 root 1.37 uint8_t smooth[MAP_LAYERS];
80 root 1.1 };
81    
82 root 1.33 #define MAX_CLIENT_X MAP_CLIENT_X
83     #define MAX_CLIENT_Y MAP_CLIENT_Y
84 root 1.1
85     struct Map
86     {
87     struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
88     };
89    
90     /* True max is 16383 given current map compaction method */
91 root 1.33 #define MAXANIMNUM 10000
92 root 1.1
93     struct statsinfo
94     {
95     char *range, *title;
96     };
97    
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     */
108 root 1.42 enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
109 root 1.1
110 root 1.15 // states the socket can be in
111     enum {
112     ST_DEAD, // socket is dead
113     ST_SETUP, // initial handshake / setup / login
114     ST_PLAYING, // logged in an playing
115     ST_CUSTOM, // waiting for custom reply
116    
117     ST_GET_PARTY_PASSWORD,
118     };
119    
120 root 1.4 // a handler for a specific type of packet
121     enum {
122 root 1.28 PF_PLAYER = 0x01, // must have valid player / will by synchronised
123     PF_PLAYING = 0x02, // must be in playing state
124     PF_COMMAND0 = 0x04, // command starts at offset 0
125     PF_COMMAND6 = 0x08, // command starts at offset 6
126 root 1.4 };
127    
128 root 1.63 // face type.s bit 0 means "has meta info prepended"
129     enum {
130     FT_FACE = 0 * 2 + 0, // faces (images)
131     FT_MUSIC = 1 * 2 + 1, // background music
132     FT_SOUND = 2 * 2 + 1, // effects
133     FT_RSRC = 3 * 2 + 0, // generic data files
134     FT_NUM,
135     };
136    
137 root 1.4 struct packet_type
138     {
139     const char *name;
140     void *cb;
141     int flags;
142     };
143    
144     struct command
145     {
146     tstamp stamp;
147     const packet_type *handler;
148     char *data;
149     int datalen;
150     };
151    
152 root 1.89 //-GPL
153    
154 root 1.1 /* how many times we are allowed to give the wrong password before being kicked. */
155     #define MAX_PASSWORD_FAILURES 5
156    
157 root 1.21 INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
158     struct client : zero_initialised, attachable
159 root 1.1 {
160     int ACC (RW, fd);
161 root 1.10 unsigned int inbuf_len; // number of bytes valid in inbuf
162 root 1.20 statsinfo stats;
163 root 1.54 object_vector_index ACC (RO, active);
164 root 1.53 player_ptr ACC (RO, pl);
165 root 1.12
166 root 1.10 char *ACC (RW, host); /* Which host it is connected from (ip address) */
167 root 1.15 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
168 root 1.25
169     sint8 ACC (RW, last_level); /* Last level we sent to client */
170     uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
171     float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
172 root 1.76 sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
173 root 1.25 sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
174     uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
175     uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
176     uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
177     living ACC (RO, last_stats); /* Last stats as sent to client */
178     float ACC (RW, last_speed); /* Last speed as sent to client */
179     sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
180     sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
181 root 1.10
182 root 1.20 bool ACC (RW, afk); /* player is afk */
183 root 1.10 bool ACC (RW, sent_scroll);
184     bool ACC (RW, sound); /* does the client want sound */
185     bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
186 root 1.40 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
187     bool ACC (RW, mapinfocmd); // return map info and send map change info
188 root 1.85 uint8_t ACC (RW, extcmd); // call into extensions/plugins
189 root 1.10 bool ACC (RW, update_look); /* If true, we need to send the look window */
190 root 1.91 bool ACC (RW, update_spells); // If true, we need to esrv_update_spells
191 root 1.10 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
192     /* used to arrange text in books, scrolls, or scripted dialogs */
193     bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
194 root 1.84 bool ACC (RW, smoothing); // deliantra-style smoothing
195 root 1.1
196 root 1.40 bool ACC (RW, force_newmap); // force a newmap before next map update
197 root 1.1 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
198     uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
199     uint16 ACC (RW, look_position); /* start of drawing of look window */
200 root 1.43 uint16 ACC (RW, mss); // likely tcp maximum segment size
201 root 1.42 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
202 root 1.1 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
203     uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
204    
205 root 1.80 maptile_ptr ACC (RW, current_map); // CF+ last/current player map
206     region_ptr ACC (RW, current_region); // CF+ last/current player region
207 root 1.1 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
208 root 1.49 shstr ACC (RW, version); // CF+ client name/version
209 root 1.32 uint8 ACC (RW, faceset); // CF+ selected faceset
210 root 1.1
211 root 1.53 tstamp ACC (RW, last_send); // last data send on socket.
212 root 1.1
213 root 1.86 float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
214 root 1.44 int ACC (RW, rate_avail); // current rate balance
215 root 1.38 int ACC (RW, max_rate); // max. # of bytes to send per tick
216 root 1.39 faceidx ACC (RW, scrub_idx); // which face to send next
217     int ACC (RW, bg_scrub); // how many ticks till the next background face send
218 root 1.45
219 root 1.65 struct tcp_info tcpi;
220     tstamp next_rate_adjust;
221 root 1.67
222     unordered_vector<char *> mapinfo_queue;
223     void mapinfo_queue_clear ();
224     void mapinfo_queue_run ();
225     bool mapinfo_try (char *buf);
226 root 1.65
227 root 1.58 struct ixsend {
228     int16_t pri; // unused
229     faceidx idx;
230     uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
231     };
232     std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
233 root 1.45
234 root 1.57 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
235 root 1.45 MTH void flush_fx (); // send fx if required
236 root 1.1
237 root 1.21 void do_destroy ();
238     void gather_callbacks (AV *&callbacks, event_type event) const;
239 root 1.4
240 root 1.70 iow socket_ev; void socket_cb (iow &w, int revents);
241 root 1.1
242 root 1.4 std::deque< command, slice_allocator<command> > cmd_queue;
243    
244 root 1.14 // large structures at the end please
245     struct Map lastmap;
246     std::bitset<MAXANIMNUM> anims_sent;
247 root 1.36 std::bitset<MAX_FACES> faces_sent;
248 root 1.63 std::bitset<FT_NUM> fx_want;
249 root 1.36
250 root 1.14 // if we get an incomplete packet, this is used to hold the data.
251     // we add 2 byte for the header, one for the trailing 0 byte
252     uint8 inbuf[MAXSOCKBUF + 2 + 1];
253    
254 root 1.49 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
255     struct msg_buf
256     {
257     tick_t expire;
258     int len;
259     int count;
260     char msg[MSG_BUF_SIZE];
261     } msgbuf[MSG_BUF_COUNT];
262    
263 root 1.92 MTH bool msg_suppressed (const_utf8_string msg);
264 root 1.49
265 root 1.82 /* The following is the setup for a ring buffer for storing output
266     * data that the OS can't handle right away.
267     * TODO: this member is enourmously large - optimise?
268     */
269     struct
270     {
271     char data[SOCKETBUFSIZE];
272     int start;
273     int len;
274     } outputbuffer;
275    
276 root 1.4 bool may_execute (const packet_type *pkt) const;
277     void execute (const packet_type *pkt, char *data, int datalen);
278    
279     void queue_command (packet_type *handler, char *data, int datalen);
280 root 1.22 MTH bool handle_command ();
281 root 1.14 // resets movement state
282 root 1.22 MTH void reset_state ();
283 root 1.25 // resets variable data used to send stat diffs
284     MTH void reset_stats ();
285 root 1.1
286 root 1.22 MTH bool handle_packet ();
287 root 1.4 int next_packet (); // returns length of packet or 0
288 root 1.1 void skip_packet (int len); // we have processed the packet, skip it
289    
290 root 1.22 MTH void flush ();
291     MTH void write_outputbuffer ();
292 root 1.38 MTH int outputbuffer_len () const { return outputbuffer.len; }
293 root 1.1 void send (void *buf_, int len);
294    
295 root 1.92 void send_packet (const_octet_string buf);
296     void send_packet (const_octet_string buf, int len);
297     void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
298 root 1.1 void send_packet (packet &sl);
299 root 1.7
300 root 1.92 void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK);
301 root 1.60
302 root 1.63 MTH void send_face (faceidx facenum, int pri = 0);
303 root 1.35 MTH void send_faces (object *ob);
304     MTH void send_animation (short anim_num);
305 root 1.92 void send_msg (int color, const_utf8_string type, const_utf8_string msg);
306 root 1.35
307 root 1.64 MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
308 root 1.10 // called when something under the player changes
309 root 1.22 MTH void floorbox_update () { update_look = 1; }
310 root 1.10 // called when the player has been moved
311 root 1.22 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
312    
313 root 1.39 MTH void tick (); // called every server tick to do housekeeping etc.
314    
315 root 1.22 MTH static client *create (int fd, const char *peername);
316 root 1.66 MTH static void clock ();
317     MTH static void flush_sockets ();
318 root 1.10
319 root 1.22 protected:
320     client (int fd, const char *from_ip);
321     ~client ();
322 root 1.1 };
323    
324 root 1.67 #if FOR_PERL
325     ACC (RW, tcpi.tcpi_state);
326     ACC (RW, tcpi.tcpi_ca_state);
327     ACC (RW, tcpi.tcpi_retransmits);
328     ACC (RW, tcpi.tcpi_probes);
329     ACC (RW, tcpi.tcpi_backoff);
330     ACC (RW, tcpi.tcpi_options);
331     ACC (RO, tcpi.tcpi_snd_wscale);
332     ACC (RO, tcpi.tcpi_rcv_wscale);
333     ACC (RW, tcpi.tcpi_rto);
334     ACC (RW, tcpi.tcpi_ato);
335     ACC (RW, tcpi.tcpi_snd_mss);
336     ACC (RW, tcpi.tcpi_rcv_mss);
337     ACC (RW, tcpi.tcpi_unacked);
338     ACC (RW, tcpi.tcpi_sacked);
339     ACC (RW, tcpi.tcpi_lost);
340     ACC (RW, tcpi.tcpi_retrans);
341     ACC (RW, tcpi.tcpi_fackets);
342     ACC (RW, tcpi.tcpi_last_data_sent);
343     ACC (RW, tcpi.tcpi_last_ack_sent);
344     ACC (RW, tcpi.tcpi_last_data_recv);
345     ACC (RW, tcpi.tcpi_last_ack_recv);
346     ACC (RW, tcpi.tcpi_pmtu);
347     ACC (RW, tcpi.tcpi_rcv_ssthresh);
348     ACC (RW, tcpi.tcpi_rtt);
349     ACC (RW, tcpi.tcpi_rttvar);
350     ACC (RW, tcpi.tcpi_snd_ssthresh);
351     ACC (RW, tcpi.tcpi_snd_cwnd);
352     ACC (RW, tcpi.tcpi_advmss);
353     ACC (RW, tcpi.tcpi_reordering);
354     #endif
355    
356 root 1.89 //+GPL
357    
358 root 1.1 #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
359     ( ((__type)>0) &&\
360     ((__sockPtr)->has_readable_type) && \
361     ((__sockPtr)->supported_readables & (1<<(__type))) )
362    
363     #define FACE_TYPES 1
364     #define PNG_FACE_INDEX 0
365    
366     #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
367 root 1.31 #define VERSION_SC 1026
368     //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
369 root 1.69 #define VERSION_INFO "Deliantra Server"
370 root 1.1
371 root 1.89 //-GPL
372    
373 root 1.24 typedef object_vector<client, &client::active> sockvec;
374 root 1.1
375     extern sockvec clients;
376 root 1.24
377     #define for_all_clients(var) \
378     for (int _i = 0; _i < clients.size (); ++_i) \
379 root 1.52 statementvar (client *, var, clients [_i])
380 root 1.24
381 root 1.78 // returns true when the message needs special (read: perl) treatment
382     static inline bool
383 root 1.92 msg_is_special (const_any_string msg, bool nl_special = true)
384 root 1.78 {
385 root 1.81 return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
386 root 1.78 }
387    
388 root 1.1 #endif
389