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.15 by root, Thu Dec 21 23:37:05 2006 UTC vs.
Revision 1.64 by root, Thu Jul 26 00:27:08 2007 UTC

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

Diff Legend

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