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.9 by root, Tue Dec 19 04:58:04 2006 UTC vs.
Revision 1.49 by root, Wed Apr 25 18:47:50 2007 UTC

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

Diff Legend

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