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.10 by root, Tue Dec 19 05:12:52 2006 UTC vs.
Revision 1.38 by root, Wed Mar 14 15:44:47 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 UUID 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 MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
79 72
80/* The following is the setup for a ring buffer for storing outbut 73/* The following is the setup for a ring buffer for storing output
81 * data that the OS can't handle right away. 74 * data that the OS can't handle right away.
82 */ 75 */
83
84struct Buffer 76struct Buffer
85{ 77{
86 char data[SOCKETBUFSIZE]; 78 char data[SOCKETBUFSIZE];
87 int start; 79 int start;
88 int len; 80 int len;
89}; 81};
90 82
83// states the socket can be in
84enum {
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_CHANGE_CLASS,
91 ST_GET_PARTY_PASSWORD,
92};
93
91// a handler for a specific type of packet 94// a handler for a specific type of packet
92enum { 95enum {
93 PF_PLAYER = 0x01, // must have valid player / will by synchronised 96 PF_PLAYER = 0x01, // must have valid player / will by synchronised
94 PF_PLAYING = 0x02, // must be in playing state 97 PF_PLAYING = 0x02, // must be in playing state
98 PF_COMMAND0 = 0x04, // command starts at offset 0
99 PF_COMMAND6 = 0x08, // command starts at offset 6
95}; 100};
96 101
97struct packet_type 102struct packet_type
98{ 103{
99 const char *name; 104 const char *name;
… …
112 { 117 {
113 sfree<char> (data, datalen + 1); 118 sfree<char> (data, datalen + 1);
114 } 119 }
115}; 120};
116 121
122struct refitem
123{
124 object_ptr op;
125};
126
127// this represents a container on the client side.
128// right now, there are only ever two of them:
129// the inventory and the floor/open container
130//TODO: unused as of yet
131struct client_container : vector< refitem, slice_allocator<refitem> >
132{
133 client *ns;
134 enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
135
136 bool item_changed; // one of the items in here possibly changed
137
138 // for mapspace and container
139 int x, y;
140 maptile *map;
141
142 // for container
143 object *env;
144
145 client_container (client *ns)
146 : ns (ns), type (CC_NONE) { }
147
148 tag_t tag () const;
149
150 inline iterator merge_item (iterator i, object *op);
151
152 void clear ();
153 void update ();
154
155 void set_mapspace (maptile *map, int x, int y);
156 void set_container (object *env);
157};
158
117/* how many times we are allowed to give the wrong password before being kicked. */ 159/* how many times we are allowed to give the wrong password before being kicked. */
118#define MAX_PASSWORD_FAILURES 5 160#define MAX_PASSWORD_FAILURES 5
119 161
120ACC_CLASS (client) // should become player when newsocket is a baseclass of player 162INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
121struct client : zero_initialised, attachable_base 163struct client : zero_initialised, attachable
122{ 164{
123 enum Sock_Status status;
124 int ACC (RW, fd); 165 int ACC (RW, fd);
125 unsigned int inbuf_len; // number of bytes valid in inbuf 166 unsigned int inbuf_len; // number of bytes valid in inbuf
126 uint8 *faces_sent; // This is a bitmap on sent face status 167 statsinfo stats;
127 struct statsinfo stats; 168 int ACC (RO, active);
169
170 Buffer outputbuffer;
128 171
129 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 172 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 */ 173 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
131 Buffer outputbuffer;
132 174
175 sint8 ACC (RW, last_level); /* Last level we sent to client */
176 uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
177 float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
178 sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
179 sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
180 uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
181 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
182 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
183 living ACC (RO, last_stats); /* Last stats as sent to client */
184 float ACC (RW, last_speed); /* Last speed as sent to client */
185 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
186 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
187
188 bool ACC (RW, afk); /* player is afk */
133 bool ACC (RW, facecache); /* If true, client is caching images */ 189 bool ACC (RW, facecache); /* If true, client is caching images */
134 bool ACC (RW, sent_scroll); 190 bool ACC (RW, sent_scroll);
135 bool ACC (RW, sound); /* does the client want sound */ 191 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 */ 192 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 */ 193 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
139 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 194 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
140 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 195 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
141 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 196 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
142 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 197 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
198 bool ACC (RW, force_face0); /* CF+ client workaround for buggy checksum calculation in gcfclient */
199 bool ACC (RW, force_bad_checksum); /* CF+ client workaround for buggy checksum calculation in gcfclient */
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 */
145 bool ACC (RW, update_look); /* If true, we need to send the look window */ 202 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 */ 203 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
147 /* used to arrange text in books, scrolls, or scripted dialogs */ 204 /* used to arrange text in books, scrolls, or scripted dialogs */
… …
155 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ 212 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
156 enum MapMode mapmode; /* Type of map commands the client wants. */ 213 enum MapMode mapmode; /* Type of map commands the client wants. */
157 uint16 ACC (RW, look_position); /* start of drawing of look window */ 214 uint16 ACC (RW, look_position); /* start of drawing of look window */
158 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 215 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 */ 216 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 217
162 maptile *ACC (RW, current_map); // CF+ last/current player map 218 maptile *ACC (RW, current_map); // CF+ last/current player map
219 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 220 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
164 char ACC (RW, version)[64]; // CF+ client name/version 221 char ACC (RW, version)[64]; // CF+ client name/version
222 uint8 ACC (RW, faceset); // CF+ selected faceset
165 223
166 player *ACC (RO, pl);//TODO should not be here, preferably 224 player_ptr ACC (RO, pl);
167 225
168 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 226 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
169 227
170 client (int fd, const char *from_ip); 228 int ACC (RW, max_rate); // max. # of bytes to send per tick
171 ~client (); 229 std::vector<faceidx> askface; // which faces have been requested by the client
230
172 void destroy (); 231 void do_destroy ();
232 void gather_callbacks (AV *&callbacks, event_type event) const;
173 233
234 iow socket_ev; void socket_cb (iow &w, int got);
174 iw cmd_ev; void cmd_cb (iw &w); 235 iw cmd_ev; void cmd_cb (iw &w);
175 iow socket_ev; void socket_cb (iow &w, int got); 236 client_container cc_inv, cc_other;
176 237
177 std::deque< command, slice_allocator<command> > cmd_queue; 238 std::deque< command, slice_allocator<command> > cmd_queue;
178 239
179 // resets movement state 240 // large structures at the end please
241 struct Map lastmap;
242 std::bitset<MAXANIMNUM> anims_sent;
243 std::bitset<MAX_FACES> faces_sent;
244
245 // 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
180 bool may_execute (const packet_type *pkt) const; 249 bool may_execute (const packet_type *pkt) const;
181 void execute (const packet_type *pkt, char *data, int datalen); 250 void execute (const packet_type *pkt, char *data, int datalen);
182 251
183 void queue_command (packet_type *handler, char *data, int datalen); 252 void queue_command (packet_type *handler, char *data, int datalen);
184 bool handle_command (); 253 MTH bool handle_command ();
254 // resets movement state
185 void reset_state (); 255 MTH void reset_state ();
256 // resets variable data used to send stat diffs
257 MTH void reset_stats ();
186 258
187 bool handle_packet (); 259 MTH bool handle_packet ();
188 int next_packet (); // returns length of packet or 0 260 int next_packet (); // returns length of packet or 0
189 void skip_packet (int len); // we have processed the packet, skip it 261 void skip_packet (int len); // we have processed the packet, skip it
190 262
191 void flush (); 263 MTH void flush ();
192 void write_outputbuffer (); 264 MTH void write_outputbuffer ();
265 MTH int outputbuffer_len () const { return outputbuffer.len; }
193 void send (void *buf_, int len); 266 void send (void *buf_, int len);
194 267
195 void send_packet (const char *buf); 268 void send_packet (const char *buf);
196 void send_packet (const char *buf, int len); 269 void send_packet (const char *buf, int len);
197 void send_packet_printf (const char *format, ...); 270 void send_packet_printf (const char *format, ...);
198 void send_packet (packet &sl); 271 void send_packet (packet &sl);
199 272
273 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
274 MTH void send_face (faceidx facenum);
275 MTH void send_image (faceidx facenum);
276 MTH void send_faces (object *ob);
277 MTH void send_animation (short anim_num);
278
200 // called when something under the player changes 279 // called when something under the player changes
201 void floorbox_update () { update_look = 1; } 280 MTH void floorbox_update () { update_look = 1; }
202 // called when the player has been moved 281 // called when the player has been moved
203 void floorbox_reset () { look_position = 0; floorbox_update (); } 282 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
204 283
205 // large structures at the end please 284 MTH static client *create (int fd, const char *peername);
206 struct Map lastmap; 285
207 std::bitset<MAXANIMNUM> anims_sent; 286protected:
208 // if we get an incomplete packet, this is used to hold the data. 287 client (int fd, const char *from_ip);
209 // we add 2 byte for the header, one for the trailing 0 byte 288 ~client ();
210 uint8 inbuf[MAXSOCKBUF + 2 + 1];
211}; 289};
212 290
213#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 291#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
214 ( ((__type)>0) &&\ 292 ( ((__type)>0) &&\
215 ((__sockPtr)->has_readable_type) && \ 293 ((__sockPtr)->has_readable_type) && \
216 ((__sockPtr)->supported_readables & (1<<(__type))) ) 294 ((__sockPtr)->supported_readables & (1<<(__type))) )
217
218/* Bitmask for the faces_sent[] array - what
219 * portion of the face have we sent?
220 */
221#define NS_FACESENT_FACE 0x1
222#define NS_FACESENT_SMOOTH 0x2
223 295
224/* Constants in the form EMI_ is for extended map infos. 296/* Constants in the form EMI_ is for extended map infos.
225 * Even if the client select the additionnal infos it wants 297 * Even if the client select the additionnal infos it wants
226 * on the map, there may exist cases where this whole info 298 * on the map, there may exist cases where this whole info
227 * is not given in one buch but in separate bunches. This 299 * is not given in one buch but in separate bunches. This
… …
249 321
250#define FACE_TYPES 1 322#define FACE_TYPES 1
251#define PNG_FACE_INDEX 0 323#define PNG_FACE_INDEX 0
252 324
253#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 325#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
254#define VERSION_SC 1027 326#define VERSION_SC 1026
327//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
255#define VERSION_INFO "Crossfire+ Server" 328#define VERSION_INFO "Crossfire+ Server"
256 329
257typedef unordered_vector<client *> sockvec; 330typedef object_vector<client, &client::active> sockvec;
258 331
259extern sockvec clients; 332extern sockvec clients;
260extern int nrofpixmaps; //TODO: hrmpf, should go 333
334#define for_all_clients(var) \
335 for (int _i = 0; _i < clients.size (); ++_i) \
336 declvar (client *, var, clients [_i])
261 337
262#endif 338#endif
263 339

Diff Legend

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