ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/client.h
Revision: 1.48
Committed: Tue Apr 24 00:42:02 2007 UTC (17 years, 1 month ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.47: +3 -2 lines
Log Message: 
- implement a rudimentary framework for a "msg" command that
  replaces drawinfo and drawextinfo and allows for simpler usage
  in simple cases and extensibility for the less complex uses.
- moved the character race choosing logic into perl, making use
  of the new msg command if the client supports it.

File Contents

# User Rev Content
1 root 1.1 /*
2 pippijn 1.26 * CrossFire, A Multiplayer game for the X Window System
3     *
4     * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5     * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6     * Copyright (C) 1992 Frank Tore Johansen
7     *
8     * This program is free software; you can redistribute it and/or modify
9     * it under the terms of the GNU General Public License as published by
10     * the Free Software Foundation; either version 2 of the License, or
11     * (at your option) any later version.
12     *
13     * This program is distributed in the hope that it will be useful,
14     * but WITHOUT ANY WARRANTY; without even the implied warranty of
15     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16     * GNU General Public License for more details.
17     *
18     * You should have received a copy of the GNU General Public License
19     * along with this program; if not, write to the Free Software
20     * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21     *
22     * The author can be reached via e-mail to crossfire@schmorp.de
23     */
24 root 1.1
25     #ifndef CLIENT_H
26     #define CLIENT_H
27    
28 root 1.4 #include <deque>
29 root 1.7 #include <bitset>
30 root 1.13 #include <tr1/unordered_set>
31 root 1.1
32 root 1.4 // (possibly) max. number of objects "per page" in the ground container
33 root 1.11 #define FLOORBOX_PAGESIZE 50
34 root 1.1
35     struct MapCell
36     {
37 root 1.47 tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
38 root 1.37 int count; /* This is really darkness in the map1 command */
39 root 1.32 faceidx faces[MAP_LAYERS];
40 root 1.36 unsigned char stat_hp; // health of something in this space, or 0
41 root 1.1 unsigned char flags;
42 root 1.37 uint8_t smooth[MAP_LAYERS];
43 root 1.1 };
44    
45 root 1.33 #define MAX_CLIENT_X MAP_CLIENT_X
46     #define MAX_CLIENT_Y MAP_CLIENT_Y
47 root 1.1
48     struct Map
49     {
50     struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
51     };
52    
53     /* True max is 16383 given current map compaction method */
54 root 1.33 #define MAXANIMNUM 10000
55 root 1.1
56     struct statsinfo
57     {
58     char *range, *title;
59     };
60    
61     /* This contains basic information on the socket structure. status is its
62     * current state. we set up our on buffers for sending/receiving, so we can
63     * handle some higher level functions. fd is the actual file descriptor we
64     * are using.
65     */
66    
67     /* Only one map mode can actually be used, so lets make it a switch
68     * instead of having a bunch of different fields that needed to
69     * get toggled.
70     */
71 root 1.42 enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
72 root 1.1
73 root 1.13 /* The following is the setup for a ring buffer for storing output
74 root 1.1 * data that the OS can't handle right away.
75     */
76     struct Buffer
77     {
78     char data[SOCKETBUFSIZE];
79     int start;
80     int len;
81     };
82    
83 root 1.15 // states the socket can be in
84     enum {
85     ST_DEAD, // socket is dead
86     ST_SETUP, // initial handshake / setup / login
87     ST_PLAYING, // logged in an playing
88     ST_CUSTOM, // waiting for custom reply
89    
90     ST_GET_PARTY_PASSWORD,
91     };
92    
93 root 1.4 // a handler for a specific type of packet
94     enum {
95 root 1.28 PF_PLAYER = 0x01, // must have valid player / will by synchronised
96     PF_PLAYING = 0x02, // must be in playing state
97     PF_COMMAND0 = 0x04, // command starts at offset 0
98     PF_COMMAND6 = 0x08, // command starts at offset 6
99 root 1.4 };
100    
101     struct packet_type
102     {
103     const char *name;
104     void *cb;
105     int flags;
106     };
107    
108     struct command
109     {
110     tstamp stamp;
111     const packet_type *handler;
112     char *data;
113     int datalen;
114    
115 root 1.6 ~command ()
116 root 1.4 {
117 root 1.8 sfree<char> (data, datalen + 1);
118 root 1.4 }
119     };
120    
121 root 1.13 struct refitem
122     {
123     object_ptr op;
124     };
125    
126 root 1.12 // this represents a container on the client side.
127     // right now, there are only ever two of them:
128     // the inventory and the floor/open container
129     //TODO: unused as of yet
130 root 1.13 struct client_container : vector< refitem, slice_allocator<refitem> >
131 root 1.12 {
132 root 1.13 client *ns;
133 root 1.12 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
134    
135 root 1.13 bool item_changed; // one of the items in here possibly changed
136    
137 root 1.12 // for mapspace and container
138 root 1.13 int x, y;
139 root 1.12 maptile *map;
140    
141     // for container
142     object *env;
143 root 1.13
144     client_container (client *ns)
145     : ns (ns), type (CC_NONE) { }
146    
147     tag_t tag () const;
148    
149     inline iterator merge_item (iterator i, object *op);
150    
151     void clear ();
152     void update ();
153    
154     void set_mapspace (maptile *map, int x, int y);
155     void set_container (object *env);
156 root 1.12 };
157    
158 root 1.1 /* how many times we are allowed to give the wrong password before being kicked. */
159     #define MAX_PASSWORD_FAILURES 5
160    
161 root 1.21 INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
162     struct client : zero_initialised, attachable
163 root 1.1 {
164     int ACC (RW, fd);
165 root 1.10 unsigned int inbuf_len; // number of bytes valid in inbuf
166 root 1.20 statsinfo stats;
167 root 1.24 int ACC (RO, active);
168 root 1.12
169 root 1.15 Buffer outputbuffer;
170 root 1.10
171     char *ACC (RW, host); /* Which host it is connected from (ip address) */
172 root 1.15 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
173 root 1.25
174     sint8 ACC (RW, last_level); /* Last level we sent to client */
175     uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
176     float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
177     sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
178     sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
179     uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
180     uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
181     uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
182     living ACC (RO, last_stats); /* Last stats as sent to client */
183     float ACC (RW, last_speed); /* Last speed as sent to client */
184     sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
185     sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
186 root 1.10
187 root 1.42 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
188     bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
189     bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
190     bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
191    
192 root 1.20 bool ACC (RW, afk); /* player is afk */
193 root 1.10 bool ACC (RW, facecache); /* If true, client is caching images */
194     bool ACC (RW, sent_scroll);
195     bool ACC (RW, sound); /* does the client want sound */
196     bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
197 root 1.40 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
198     bool ACC (RW, mapinfocmd); // return map info and send map change info
199     bool ACC (RW, extcmd); // call into extensions/plugins
200     bool ACC (RW, extmap); // extend map comamnd with extra data
201     bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
202 root 1.10 bool ACC (RW, darkness); /* True if client wants darkness information */
203     bool ACC (RW, image2); /* Client wants image2/face2 commands */
204 root 1.44 bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
205 root 1.10 bool ACC (RW, update_look); /* If true, we need to send the look window */
206     bool ACC (RW, has_readable_type); /* If true client accept additional text information */
207     /* used to arrange text in books, scrolls, or scripted dialogs */
208     bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
209     bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
210     /* Below are flags for extedend infos to pass to client
211     * with S->C mapextended command */
212     bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
213 root 1.48 bool ACC (RW, smoothing); // trt-style smoothing
214     bool ACC (RW, can_msg); // trt-style text messages
215 root 1.1
216 root 1.40 bool ACC (RW, force_newmap); // force a newmap before next map update
217 root 1.1 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
218     uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
219     uint16 ACC (RW, look_position); /* start of drawing of look window */
220 root 1.43 uint16 ACC (RW, mss); // likely tcp maximum segment size
221 root 1.42 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
222 root 1.1 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
223     uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
224    
225     maptile *ACC (RW, current_map); // CF+ last/current player map
226 root 1.29 region *ACC (RW, current_region); // CF+ last/current player region
227 root 1.1 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
228 root 1.10 char ACC (RW, version)[64]; // CF+ client name/version
229 root 1.32 uint8 ACC (RW, faceset); // CF+ selected faceset
230 root 1.1
231 root 1.18 player_ptr ACC (RO, pl);
232 root 1.1
233 root 1.38 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
234    
235 root 1.44 int ACC (RW, rate_avail); // current rate balance
236 root 1.38 int ACC (RW, max_rate); // max. # of bytes to send per tick
237 root 1.39 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
239 root 1.45
240     faceidx partial_face;
241     uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face
242     std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client
243    
244     std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
245     MTH void flush_fx (); // send fx if required
246 root 1.1
247 root 1.21 void do_destroy ();
248     void gather_callbacks (AV *&callbacks, event_type event) const;
249 root 1.4
250 pippijn 1.30 iow socket_ev; void socket_cb (iow &w, int got);
251 root 1.4 iw cmd_ev; void cmd_cb (iw &w);
252 pippijn 1.30 client_container cc_inv, cc_other;
253 root 1.1
254 root 1.4 std::deque< command, slice_allocator<command> > cmd_queue;
255    
256 root 1.14 // large structures at the end please
257     struct Map lastmap;
258     std::bitset<MAXANIMNUM> anims_sent;
259 root 1.36 std::bitset<MAX_FACES> faces_sent;
260    
261 root 1.14 // if we get an incomplete packet, this is used to hold the data.
262     // we add 2 byte for the header, one for the trailing 0 byte
263     uint8 inbuf[MAXSOCKBUF + 2 + 1];
264    
265 root 1.4 bool may_execute (const packet_type *pkt) const;
266     void execute (const packet_type *pkt, char *data, int datalen);
267    
268     void queue_command (packet_type *handler, char *data, int datalen);
269 root 1.22 MTH bool handle_command ();
270 root 1.14 // resets movement state
271 root 1.22 MTH void reset_state ();
272 root 1.25 // resets variable data used to send stat diffs
273     MTH void reset_stats ();
274 root 1.1
275 root 1.22 MTH bool handle_packet ();
276 root 1.4 int next_packet (); // returns length of packet or 0
277 root 1.1 void skip_packet (int len); // we have processed the packet, skip it
278    
279 root 1.22 MTH void flush ();
280     MTH void write_outputbuffer ();
281 root 1.38 MTH int outputbuffer_len () const { return outputbuffer.len; }
282 root 1.1 void send (void *buf_, int len);
283    
284     void send_packet (const char *buf);
285     void send_packet (const char *buf, int len);
286 root 1.4 void send_packet_printf (const char *format, ...);
287 root 1.1 void send_packet (packet &sl);
288 root 1.7
289 root 1.35 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
290 root 1.38 MTH void send_face (faceidx facenum);
291     MTH void send_image (faceidx facenum);
292 root 1.35 MTH void send_faces (object *ob);
293     MTH void send_animation (short anim_num);
294 root 1.48 MTH void send_msg (int color, const char *type, const char *msg);
295 root 1.35
296 root 1.10 // called when something under the player changes
297 root 1.22 MTH void floorbox_update () { update_look = 1; }
298 root 1.10 // called when the player has been moved
299 root 1.22 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
300    
301 root 1.39 MTH void tick (); // called every server tick to do housekeeping etc.
302    
303 root 1.22 MTH static client *create (int fd, const char *peername);
304 root 1.10
305 root 1.22 protected:
306     client (int fd, const char *from_ip);
307     ~client ();
308 root 1.1 };
309    
310     #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
311     ( ((__type)>0) &&\
312     ((__sockPtr)->has_readable_type) && \
313     ((__sockPtr)->supported_readables & (1<<(__type))) )
314    
315     /* Constants in the form EMI_ is for extended map infos.
316     * Even if the client select the additionnal infos it wants
317     * on the map, there may exist cases where this whole info
318     * is not given in one buch but in separate bunches. This
319     * is done performance reasons (imagine some info related to
320     * a visible object and another info related to a 4 square
321     * width and height area). At the begin of an extended info packet
322     * is a bit field. A bit is activated for each extended info
323     * present in the data
324     */
325    
326     /* Meanings:
327     * EMI_NOREDRAW Take extended infos into account but don't redraw,
328     * some additionnal datas will follow in a new packet
329     * EMI_SMOOTH Datas about smoothing
330     */
331     #define EMI_NOREDRAW 0x01
332     #define EMI_SMOOTH 0x02
333    
334     /* this last one says the bitfield continue un next byte
335     * There may be several on contiguous bytes. So there is 7
336     * actual bits used per byte, and the number of bytes
337     * is not fixed in protocol
338     */
339     #define EMI_HASMOREBITS 0x80
340    
341     #define FACE_TYPES 1
342     #define PNG_FACE_INDEX 0
343    
344     #define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
345 root 1.31 #define VERSION_SC 1026
346     //#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
347 root 1.1 #define VERSION_INFO "Crossfire+ Server"
348    
349 root 1.24 typedef object_vector<client, &client::active> sockvec;
350 root 1.1
351     extern sockvec clients;
352 root 1.24
353     #define for_all_clients(var) \
354     for (int _i = 0; _i < clients.size (); ++_i) \
355     declvar (client *, var, clients [_i])
356    
357 root 1.1 #endif
358