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.57 by root, Sun Jul 1 03:16:56 2007 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for the X Window System 2 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
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 it
8 it under the terms of the GNU General Public License as published by 9 * under the terms of the GNU General Public License as published by the Free
9 the Free Software Foundation; either version 2 of the License, or 10 * Software Foundation; either version 2 of the License, or (at your option)
10 (at your option) any later version. 11 * 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, but
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 GNU General Public License for more details. 16 * 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 along
18 along with this program; if not, write to the Free Software 19 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 21 *
21 The author can be reached via e-mail to crossfire@schmorp.de 22 * The authors 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 tag_t 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];
38 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
39 unsigned char flags; 41 unsigned char flags;
42 uint8_t smooth[MAP_LAYERS];
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 { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
78 72
79/* The following is the setup for a ring buffer for storing outbut 73// states the socket can be in
80 * data that the OS can't handle right away. 74enum {
81 */ 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
82 79
83struct Buffer 80 ST_GET_PARTY_PASSWORD,
84{
85 char data[SOCKETBUFSIZE];
86 int start;
87 int len;
88}; 81};
89 82
90// a handler for a specific type of packet 83// a handler for a specific type of packet
91enum { 84enum {
92 PF_PLAYER = 0x01, // must have valid player 85 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 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;
… …
106 tstamp stamp; 100 tstamp stamp;
107 const packet_type *handler; 101 const packet_type *handler;
108 char *data; 102 char *data;
109 int datalen; 103 int datalen;
110 104
111 command (tstamp stamp, const packet_type *handler, char *data, int datalen) 105 ~command ()
112 : stamp (stamp), handler (handler), data (data), datalen (datalen)
113 { 106 {
107 sfree<char> (data, datalen + 1);
114 } 108 }
115}; 109};
116 110
117/* how many times we are allowed to give the wrong password before being kicked. */ 111/* how many times we are allowed to give the wrong password before being kicked. */
118#define MAX_PASSWORD_FAILURES 5 112#define MAX_PASSWORD_FAILURES 5
119 113
120ACC_CLASS (client) // should become player when newsocket is a baseclass of player 114INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
121struct client : zero_initialised, attachable_base 115struct client : zero_initialised, attachable
122{ 116{
123 enum Sock_Status status;
124 int ACC (RW, fd); 117 int ACC (RW, fd);
125 unsigned int inbuf_len; // number of bytes valid in inbuf 118 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; 119 statsinfo stats;
120 object_vector_index ACC (RO, active);
121 player_ptr ACC (RO, pl);
122
123 /* The following is the setup for a ring buffer for storing output
124 * data that the OS can't handle right away.
125 */
126 struct
127 {
128 char data[SOCKETBUFSIZE];
129 int start;
130 int len;
131 } outputbuffer;
131 132
132 char *ACC (RW, host); /* Which host it is connected from (ip address) */ 133 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 */ 134 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
134 Buffer outputbuffer; /* For undeliverable data */
135 135
136 sint8 ACC (RW, last_level); /* Last level we sent to client */
137 uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
138 float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
139 sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
140 sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
141 uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
142 uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
143 uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
144 living ACC (RO, last_stats); /* Last stats as sent to client */
145 float ACC (RW, last_speed); /* Last speed as sent to client */
146 sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
147 sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
148
149 bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
150 bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
151 bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
152 bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
153
154 bool ACC (RW, afk); /* player is afk */
136 bool ACC (RW, facecache); /* If true, client is caching images */ 155 bool ACC (RW, facecache); /* If true, client is caching images */
137 bool ACC (RW, sent_scroll); 156 bool ACC (RW, sent_scroll);
138 bool ACC (RW, sound); /* does the client want sound */ 157 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 */ 158 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 */ 159 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
142 bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ 160 bool ACC (RW, mapinfocmd); // return map info and send map change info
143 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 161 bool ACC (RW, extcmd); // call into extensions/plugins
144 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 162 bool ACC (RW, extmap); // extend map comamnd with extra data
145 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 163 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
146 bool ACC (RW, darkness); /* True if client wants darkness information */ 164 bool ACC (RW, darkness); /* True if client wants darkness information */
147 bool ACC (RW, image2); /* Client wants image2/face2 commands */ 165 bool ACC (RW, image2); /* Client wants image2/face2 commands */
166 uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
148 bool ACC (RW, update_look); /* If true, we need to send the look window */ 167 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 */ 168 bool ACC (RW, has_readable_type); /* If true client accept additional text information */
150 /* used to arrange text in books, scrolls, or scripted dialogs */ 169 /* 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 */ 170 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 */ 171 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
153 /* Below are flags for extedend infos to pass to client 172 /* Below are flags for extedend infos to pass to client
154 * with S->C mapextended command */ 173 * with S->C mapextended command */
155 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ 174 bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
175 bool ACC (RW, smoothing); // trt-style smoothing
176 bool ACC (RW, can_msg); // trt-style text messages
156 177
178 bool ACC (RW, force_newmap); // force a newmap before next map update
157 uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ 179 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 */ 180 uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
159 enum MapMode mapmode; /* Type of map commands the client wants. */
160 uint16 ACC (RW, look_position); /* start of drawing of look window */ 181 uint16 ACC (RW, look_position); /* start of drawing of look window */
182 uint16 ACC (RW, mss); // likely tcp maximum segment size
183 uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
161 uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ 184 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 */ 185 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 186
165 maptile *ACC (RW, current_map); // CF+ last/current player map 187 maptile *ACC (RW, current_map); // CF+ last/current player map
188 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 189 int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
167 char ACC (RW, version)[64]; // CF+ client name/version 190 shstr ACC (RW, version); // CF+ client name/version
191 uint8 ACC (RW, faceset); // CF+ selected faceset
192
193 tstamp ACC (RW, last_send); // last data send on socket.
194
195 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
196
197 int ACC (RW, rate_avail); // current rate balance
198 int ACC (RW, max_rate); // max. # of bytes to send per tick
199 faceidx ACC (RW, scrub_idx); // which face to send next
200 int ACC (RW, bg_scrub); // how many ticks till the next background face send
201
202 faceidx partial_face;
203 uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face
204 std::vector<faceidx, slice_allocator<faceidx> > ixface; // which faces to send to the client using ix
205
206 std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
207 MTH void flush_fx (); // send fx if required
208
209 void do_destroy ();
210 void gather_callbacks (AV *&callbacks, event_type event) const;
211
212 iow socket_ev; void socket_cb (iow &w, int got);
213 iw cmd_ev; void cmd_cb (iw &w);
214
215 std::deque< command, slice_allocator<command> > cmd_queue;
216
217 // large structures at the end please
218 struct Map lastmap;
219 std::bitset<MAXANIMNUM> anims_sent;
220 std::bitset<MAX_FACES> faces_sent;
168 221
169 // if we get an incomplete packet, this is used to hold the data. 222 // 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 223 // we add 2 byte for the header, one for the trailing 0 byte
171 uint8 inbuf[MAXSOCKBUF + 2 + 1]; 224 uint8 inbuf[MAXSOCKBUF + 2 + 1];
172 player *ACC (RO, pl);//TODO should not be here, preferably
173 225
174 int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ 226 enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
227 struct msg_buf
228 {
229 tick_t expire;
230 int len;
231 int count;
232 char msg[MSG_BUF_SIZE];
233 } msgbuf[MSG_BUF_COUNT];
175 234
176 client (int fd, const char *from_ip); 235 MTH bool msg_suppressed (const char *msg);
177 ~client ();
178 void destroy ();
179 236
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; 237 bool may_execute (const packet_type *pkt) const;
187 void execute (const packet_type *pkt, char *data, int datalen); 238 void execute (const packet_type *pkt, char *data, int datalen);
188 239
189 void queue_command (packet_type *handler, char *data, int datalen); 240 void queue_command (packet_type *handler, char *data, int datalen);
190 bool handle_command (); 241 MTH bool handle_command ();
242 // resets movement state
243 MTH void reset_state ();
244 // resets variable data used to send stat diffs
245 MTH void reset_stats ();
191 246
192 bool handle_packet (); 247 MTH bool handle_packet ();
193 int next_packet (); // returns length of packet or 0 248 int next_packet (); // returns length of packet or 0
194 void skip_packet (int len); // we have processed the packet, skip it 249 void skip_packet (int len); // we have processed the packet, skip it
195 250
196 void flush (); 251 MTH void flush ();
197 void write_outputbuffer (); 252 MTH void write_outputbuffer ();
253 MTH int outputbuffer_len () const { return outputbuffer.len; }
198 void send (void *buf_, int len); 254 void send (void *buf_, int len);
199 255
200 void send_packet (const char *buf); 256 void send_packet (const char *buf);
201 void send_packet (const char *buf, int len); 257 void send_packet (const char *buf, int len);
202 void send_packet_printf (const char *format, ...); 258 void send_packet_printf (const char *format, ...);
203 void send_packet (packet &sl); 259 void send_packet (packet &sl);
260
261 void send_drawinfo (const char *msg, int flags = NDI_BLACK);
262 MTH void send_face (faceidx facenum);
263 MTH void send_image (faceidx facenum);
264 MTH void send_faces (object *ob);
265 MTH void send_animation (short anim_num);
266 void send_msg (int color, const char *type, const char *msg);
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 void tick (); // called every server tick to do housekeeping etc.
274
275 MTH static client *create (int fd, const char *peername);
276
277protected:
278 client (int fd, const char *from_ip);
279 ~client ();
204}; 280};
205 281
206#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 282#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
207 ( ((__type)>0) &&\ 283 ( ((__type)>0) &&\
208 ((__sockPtr)->has_readable_type) && \ 284 ((__sockPtr)->has_readable_type) && \
209 ((__sockPtr)->supported_readables & (1<<(__type))) ) 285 ((__sockPtr)->supported_readables & (1<<(__type))) )
210
211/* Bitmask for the faces_sent[] array - what
212 * portion of the face have we sent?
213 */
214#define NS_FACESENT_FACE 0x1
215#define NS_FACESENT_SMOOTH 0x2
216 286
217/* Constants in the form EMI_ is for extended map infos. 287/* Constants in the form EMI_ is for extended map infos.
218 * Even if the client select the additionnal infos it wants 288 * Even if the client select the additionnal infos it wants
219 * on the map, there may exist cases where this whole info 289 * on the map, there may exist cases where this whole info
220 * is not given in one buch but in separate bunches. This 290 * is not given in one buch but in separate bunches. This
… …
242 312
243#define FACE_TYPES 1 313#define FACE_TYPES 1
244#define PNG_FACE_INDEX 0 314#define PNG_FACE_INDEX 0
245 315
246#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 316#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
247#define VERSION_SC 1027 317#define VERSION_SC 1026
318//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
248#define VERSION_INFO "Crossfire+ Server" 319#define VERSION_INFO "Crossfire TRT Server"
249 320
250typedef unordered_vector<client *> sockvec; 321typedef object_vector<client, &client::active> sockvec;
251 322
252extern sockvec clients; 323extern sockvec clients;
253extern int nrofpixmaps; //TODO: hrmpf, should go 324
325#define for_all_clients(var) \
326 for (int _i = 0; _i < clients.size (); ++_i) \
327 statementvar (client *, var, clients [_i])
254 328
255#endif 329#endif
256 330

Diff Legend

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