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.4 by root, Sat Dec 16 03:08:26 2006 UTC vs.
Revision 1.34 by root, Mon Mar 12 23:45:10 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>
29#include <bitset>
30#include <tr1/unordered_set>
28 31
29// (possibly) max. number of objects "per page" in the ground container 32// (possibly) max. number of objects "per page" in the ground container
30#define NUM_LOOK_OBJECTS 50 33#define FLOORBOX_PAGESIZE 50
31 34
32struct MapCell 35struct MapCell
33{ 36{
34 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
35 int count; /* This is really darkness in the map1 command */ 38 int count; /* This is really darkness in the map1 command */
36 uint16 faces[MAP_LAYERS]; 39 faceidx faces[MAP_LAYERS];
37 uint16 smooth[MAP_LAYERS]; 40 uint16 smooth[MAP_LAYERS];
38 unsigned char stat_hp; // health of something in this space, or 0 41 unsigned char stat_hp; // health of something in this space, or 0
39 unsigned char flags; 42 unsigned char flags;
40}; 43};
41 44
42/* This basically defines the largest size an
43 * archetype may be - it is used for allocation of
44 * some structures, as well as determining how far
45 * we should look for the heads of big images.
46 */
47#define MAX_HEAD_OFFSET 8
48
49#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) 45#define MAX_CLIENT_X MAP_CLIENT_X
50#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) 46#define MAX_CLIENT_Y MAP_CLIENT_Y
51 47
52struct Map 48struct Map
53{ 49{
54 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; 50 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
55}; 51};
56 52
57/* True max is 16383 given current map compaction method */ 53/* True max is 16383 given current map compaction method */
58# define MAXANIMNUM 2000 54#define MAXANIMNUM 10000
59 55
60struct statsinfo 56struct statsinfo
61{ 57{
62 char *range, *title; 58 char *range, *title;
63}; 59};
… …
66 * 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
67 * 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
68 * are using. 64 * are using.
69 */ 65 */
70 66
71enum Sock_Status { Ns_Add, Ns_Dead };
72
73/* 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
74 * instead of having a bunch of different fields that needed to 68 * instead of having a bunch of different fields that needed to
75 * get toggled. 69 * get toggled.
76 */ 70 */
77enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 71enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
78 72
79/* 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
80 * data that the OS can't handle right away. 74 * data that the OS can't handle right away.
81 */ 75 */
82
83struct Buffer 76struct Buffer
84{ 77{
85 char data[SOCKETBUFSIZE]; 78 char data[SOCKETBUFSIZE];
86 int start; 79 int start;
87 int len; 80 int len;
88}; 81};
89 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
90// a handler for a specific type of packet 94// a handler for a specific type of packet
91enum { 95enum {
92 PF_PLAYER = 0x01, // must have valid player 96 PF_PLAYER = 0x01, // must have valid player / will by synchronised
93 PF_IMMEDIATE = 0x02, // TODO: hack, can be executed immediately
94 PF_PLAYING = 0x04, // 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;
… …
106 tstamp stamp; 111 tstamp stamp;
107 const packet_type *handler; 112 const packet_type *handler;
108 char *data; 113 char *data;
109 int datalen; 114 int datalen;
110 115
111 command (tstamp stamp, const packet_type *handler, char *data, int datalen) 116 ~command ()
112 : stamp (stamp), handler (handler), data (data), datalen (datalen)
113 { 117 {
118 sfree<char> (data, datalen + 1);
114 } 119 }
120};
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);
115}; 157};
116 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 struct Map lastmap;
127 size_t faces_sent_len; /* This is the number of elements allocated in faces_sent[] */
128 uint8 *faces_sent; /* This is a bitmap on sent face status */
129 uint8 anims_sent[MAXANIMNUM];
130 struct statsinfo stats; 167 statsinfo stats;
168 int ACC (RO, active);
169
170 Buffer outputbuffer;
131 171
132 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) */
133 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 */
134 Buffer outputbuffer; /* For undeliverable data */
135 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 */
136 bool ACC (RW, facecache); /* If true, client is caching images */ 189 bool ACC (RW, facecache); /* If true, client is caching images */
137 bool ACC (RW, sent_scroll); 190 bool ACC (RW, sent_scroll);
138 bool ACC (RW, sound); /* does the client want sound */ 191 bool ACC (RW, sound); /* does the client want sound */
139 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
140 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 */
141 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 */
142 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 */
143 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 195 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
144 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 196 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
145 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 */
146 bool ACC (RW, darkness); /* True if client wants darkness information */ 200 bool ACC (RW, darkness); /* True if client wants darkness information */
147 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 201 bool ACC (RW, image2); /* Client wants image2/face2 commands */
148 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 */
149 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 */
150 /* used to arrange text in books, scrolls, or scripted dialogs */ 204 /* used to arrange text in books, scrolls, or scripted dialogs */
151 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ 205 bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
152 bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */ 206 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
153 /* Below are flags for extedend infos to pass to client 207 /* Below are flags for extedend infos to pass to client
154 * with S->C mapextended command */ 208 * with S->C mapextended command */
155 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 209 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
156 210
157 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 211 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
158 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 */
159 enum MapMode mapmode; /* Type of map commands the client wants. */ 213 enum MapMode mapmode; /* Type of map commands the client wants. */
160 uint16 ACC (RW, look_position); /* start of drawing of look window */ 214 uint16 ACC (RW, look_position); /* start of drawing of look window */
161 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 */
162 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 */
163 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
164 217
165 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
166 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
167 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
168 223
224 player_ptr ACC (RO, pl);
225
226 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
227
228 void do_destroy ();
229 void gather_callbacks (AV *&callbacks, event_type event) const;
230
231 iow socket_ev; void socket_cb (iow &w, int got);
232 iw cmd_ev; void cmd_cb (iw &w);
233 client_container cc_inv, cc_other;
234
235 std::deque< command, slice_allocator<command> > cmd_queue;
236
237 // large structures at the end please
238 struct Map lastmap;
239 std::bitset<MAXANIMNUM> anims_sent;
240 uint8 ACC (RW, faces_sent[MAX_FACES]); // This is a bitmap on sent face status
169 // if we get an incomplete packet, this is used to hold the data. 241 // if we get an incomplete packet, this is used to hold the data.
170 // we add 2 byte for the header, one for the trailing 0 byte 242 // we add 2 byte for the header, one for the trailing 0 byte
171 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 243 uint8 inbuf[MAXSOCKBUF + 2 + 1];
172 player *ACC (RO, pl);//TODO should not be here, preferably
173 244
174 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
175
176 client (int fd, const char *from_ip);
177 ~client ();
178 void destroy ();
179
180 iw cmd_ev; void cmd_cb (iw &w);
181 iow socket_ev; void socket_cb (iow &w, int got);
182
183 std::deque< command, slice_allocator<command> > cmd_queue;
184
185 // those should probably be client methods
186 bool may_execute (const packet_type *pkt) const; 245 bool may_execute (const packet_type *pkt) const;
187 void execute (const packet_type *pkt, char *data, int datalen); 246 void execute (const packet_type *pkt, char *data, int datalen);
188 247
189 void queue_command (packet_type *handler, char *data, int datalen); 248 void queue_command (packet_type *handler, char *data, int datalen);
190 bool handle_command (); 249 MTH bool handle_command ();
250 // resets movement state
251 MTH void reset_state ();
252 // resets variable data used to send stat diffs
253 MTH void reset_stats ();
191 254
192 bool handle_packet (); 255 MTH bool handle_packet ();
193 int next_packet (); // returns length of packet or 0 256 int next_packet (); // returns length of packet or 0
194 void skip_packet (int len); // we have processed the packet, skip it 257 void skip_packet (int len); // we have processed the packet, skip it
195 258
196 void flush (); 259 MTH void flush ();
197 void write_outputbuffer (); 260 MTH void write_outputbuffer ();
198 void send (void *buf_, int len); 261 void send (void *buf_, int len);
199 262
200 void send_packet (const char *buf); 263 void send_packet (const char *buf);
201 void send_packet (const char *buf, int len); 264 void send_packet (const char *buf, int len);
202 void send_packet_printf (const char *format, ...); 265 void send_packet_printf (const char *format, ...);
203 void send_packet (packet &sl); 266 void send_packet (packet &sl);
267
268 // called when something under the player changes
269 MTH void floorbox_update () { update_look = 1; }
270 // called when the player has been moved
271 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
272
273 MTH static client *create (int fd, const char *peername);
274
275protected:
276 client (int fd, const char *from_ip);
277 ~client ();
204}; 278};
205 279
206#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 280#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
207 ( ((__type)>0) &&\ 281 ( ((__type)>0) &&\
208 ((__sockPtr)->has_readable_type) && \ 282 ((__sockPtr)->has_readable_type) && \
… …
242 316
243#define FACE_TYPES 1 317#define FACE_TYPES 1
244#define PNG_FACE_INDEX 0 318#define PNG_FACE_INDEX 0
245 319
246#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 320#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
247#define VERSION_SC 1027 321#define VERSION_SC 1026
322//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
248#define VERSION_INFO "Crossfire+ Server" 323#define VERSION_INFO "Crossfire+ Server"
249 324
250typedef unordered_vector<client *> sockvec; 325typedef object_vector<client, &client::active> sockvec;
251 326
252extern sockvec clients; 327extern sockvec clients;
253extern int nrofpixmaps; //TODO: hrmpf, should go 328
329#define for_all_clients(var) \
330 for (int _i = 0; _i < clients.size (); ++_i) \
331 declvar (client *, var, clients [_i])
254 332
255#endif 333#endif
256 334

Diff Legend

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