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.3 by root, Fri Dec 15 20:08:45 2006 UTC vs.
Revision 1.63 by root, Tue Jul 24 04:55:34 2007 UTC

1
2/* 1/*
3 CrossFire, A Multiplayer game for the X Window System 2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
4 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5 Copyright (C) 2002 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 7 *
8 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
9 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
10 the Free Software Foundation; either version 2 of the License, or 10 * the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version. 11 * (at your option) any later version.
12 12 *
13 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,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details. 16 * GNU General Public License for more details.
17 17 *
18 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
19 along with this program; if not, write to the Free Software 19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 *
21
22 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>
23*/ 22 */
24
25/*
26 newserver.h defines various structures and values that are use for the
27 new client server communication method. Values defined here are only
28 used on the server side code. For shared client/server values, see
29 newclient.h
30*/
31 23
32#ifndef CLIENT_H 24#ifndef CLIENT_H
33#define CLIENT_H 25#define CLIENT_H
34 26
35/* Reduce this from 50 to 5 - as it is now, there will never be more 27#include <deque>
36 * than 3 anyways. 28#include <bitset>
37 */ 29#include <tr1/unordered_set>
38 30
39#define NUM_LOOK_OBJECTS 50 31// (possibly) max. number of objects "per page" in the ground container
32#define FLOORBOX_PAGESIZE 50
40 33
41struct MapCell 34struct MapCell
42{ 35{
43 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
44 int count; /* This is really darkness in the map1 command */ 37 int count; /* This is really darkness in the map1 command */
45 uint16 faces[MAP_LAYERS]; 38 faceidx faces[MAP_LAYERS];
46 uint16 smooth[MAP_LAYERS];
47 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
48 unsigned char flags; 40 unsigned char flags;
41 uint8_t smooth[MAP_LAYERS];
49}; 42};
50 43
51/* This basically defines the largest size an
52 * archetype may be - it is used for allocation of
53 * some structures, as well as determining how far
54 * we should look for the heads of big images.
55 */
56#define MAX_HEAD_OFFSET 8
57
58#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) 44#define MAX_CLIENT_X MAP_CLIENT_X
59#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) 45#define MAX_CLIENT_Y MAP_CLIENT_Y
60 46
61struct Map 47struct Map
62{ 48{
63 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; 49 struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
64}; 50};
65 51
66/* True max is 16383 given current map compaction method */ 52/* True max is 16383 given current map compaction method */
67# define MAXANIMNUM 2000 53#define MAXANIMNUM 10000
68 54
69struct statsinfo 55struct statsinfo
70{ 56{
71 char *range, *title; 57 char *range, *title;
72}; 58};
… …
75 * current state. we set up our on buffers for sending/receiving, so we can 61 * current state. we set up our on buffers for sending/receiving, so we can
76 * handle some higher level functions. fd is the actual file descriptor we 62 * handle some higher level functions. fd is the actual file descriptor we
77 * are using. 63 * are using.
78 */ 64 */
79 65
80enum Sock_Status { Ns_Add, Ns_Dead };
81
82/* 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
83 * instead of having a bunch of different fields that needed to 67 * instead of having a bunch of different fields that needed to
84 * get toggled. 68 * get toggled.
85 */ 69 */
86enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; 70enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
87 71
88/* The following is the setup for a ring buffer for storing outbut 72// states the socket can be in
89 * data that the OS can't handle right away. 73enum {
90 */ 74 ST_DEAD, // socket is dead
75 ST_SETUP, // initial handshake / setup / login
76 ST_PLAYING, // logged in an playing
77 ST_CUSTOM, // waiting for custom reply
91 78
92struct Buffer 79 ST_GET_PARTY_PASSWORD,
80};
81
82// a handler for a specific type of packet
83enum {
84 PF_PLAYER = 0x01, // must have valid player / will by synchronised
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,
97};
98
99struct packet_type
93{ 100{
94 char data[SOCKETBUFSIZE]; 101 const char *name;
95 int start; 102 void *cb;
103 int flags;
104};
105
106struct command
107{
108 tstamp stamp;
109 const packet_type *handler;
110 char *data;
96 int len; 111 int datalen;
112
113 ~command ()
114 {
115 sfree<char> (data, datalen + 1);
116 }
97}; 117};
98 118
99/* 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. */
100#define MAX_PASSWORD_FAILURES 5 120#define MAX_PASSWORD_FAILURES 5
101 121
102ACC_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
103struct client : zero_initialised, attachable_base 123struct client : zero_initialised, attachable
104{ 124{
105 enum Sock_Status status;
106 int ACC (RW, fd); 125 int ACC (RW, fd);
107 unsigned int inbuf_len; // number of bytes valid in inbuf 126 unsigned int inbuf_len; // number of bytes valid in inbuf
108 struct Map lastmap;
109 size_t faces_sent_len; /* This is the number of elements allocated in faces_sent[] */
110 uint8 *faces_sent; /* This is a bitmap on sent face status */
111 uint8 anims_sent[MAXANIMNUM];
112 struct statsinfo stats; 127 statsinfo stats;
128 object_vector_index ACC (RO, active);
129 player_ptr ACC (RO, pl);
130
131 /* The following is the setup for a ring buffer for storing output
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;
113 140
114 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) */
115 uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ 142 uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
116 Buffer outputbuffer; /* For undeliverable data */
117 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 */
118 bool ACC (RW, facecache); /* If true, client is caching images */ 163 bool ACC (RW, facecache); /* If true, client is caching images */
119 bool ACC (RW, sent_scroll); 164 bool ACC (RW, sent_scroll);
120 bool ACC (RW, sound); /* does the client want sound */ 165 bool ACC (RW, sound); /* does the client want sound */
121 bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
122 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 */
123 bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ 167 bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
124 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
125 bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ 169 uint8_t ACC (RW, extcmd); // call into extensions/plugins
126 bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ 170 bool ACC (RW, extmap); // extend map comamnd with extra data
127 bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ 171 bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
128 bool ACC (RW, darkness); /* True if client wants darkness information */ 172 bool ACC (RW, darkness); /* True if client wants darkness information */
129 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
130 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 */
131 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 */
132 /* used to arrange text in books, scrolls, or scripted dialogs */ 177 /* used to arrange text in books, scrolls, or scripted dialogs */
133 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 */
134 bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */ 179 bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
135 /* Below are flags for extedend infos to pass to client 180 /* Below are flags for extedend infos to pass to client
136 * with S->C mapextended command */ 181 * with S->C mapextended command */
137 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
138 185
186 bool ACC (RW, force_newmap); // force a newmap before next map update
139 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 */
140 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 */
141 enum MapMode mapmode; /* Type of map commands the client wants. */
142 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. */
143 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 */
144 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 */
145 uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
146 194
147 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
148 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
149 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
150 200
151 /* If we get an incomplete packet, this is used to hold the data. */ 201 tstamp ACC (RW, last_send); // last data send on socket.
152 uint8 inbuf[MAXSOCKBUF];
153 player *ACC (RO, pl);//TODO should not be here, preferably
154 202
155 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
205
206 int ACC (RW, rate_avail); // current rate balance
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
221 void do_destroy ();
222 void gather_callbacks (AV *&callbacks, event_type event) const;
156 223
157 iow socket_ev; void socket_cb (iow &w, int got); 224 iow socket_ev; void socket_cb (iow &w, int got);
225 iw cmd_ev; void cmd_cb (iw &w);
158 226
227 std::deque< command, slice_allocator<command> > cmd_queue;
228
229 // large structures at the end please
230 struct Map lastmap;
231 std::bitset<MAXANIMNUM> anims_sent;
232 std::bitset<MAX_FACES> faces_sent;
233 std::bitset<FT_NUM> fx_want;
234
235 // if we get an incomplete packet, this is used to hold the data.
236 // we add 2 byte for the header, one for the trailing 0 byte
237 uint8 inbuf[MAXSOCKBUF + 2 + 1];
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
250 bool may_execute (const packet_type *pkt) const;
251 void execute (const packet_type *pkt, char *data, int datalen);
252
253 void queue_command (packet_type *handler, char *data, int datalen);
254 MTH bool handle_command ();
255 // resets movement state
256 MTH void reset_state ();
257 // resets variable data used to send stat diffs
258 MTH void reset_stats ();
259
260 MTH bool handle_packet ();
261 int next_packet (); // returns length of packet or 0
262 void skip_packet (int len); // we have processed the packet, skip it
263
264 MTH void flush ();
265 MTH void write_outputbuffer ();
266 MTH int outputbuffer_len () const { return outputbuffer.len; }
267 void send (void *buf_, int len);
268
269 void send_packet (const char *buf);
270 void send_packet (const char *buf, int len);
271 void send_packet_printf (const char *format, ...);
272 void send_packet (packet &sl);
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 // called when something under the player changes
283 MTH void floorbox_update () { update_look = 1; }
284 // called when the player has been moved
285 MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
286
287 MTH void tick (); // called every server tick to do housekeeping etc.
288
289 MTH static client *create (int fd, const char *peername);
290
291protected:
159 client (int fd, const char *from_ip); 292 client (int fd, const char *from_ip);
160 ~client (); 293 ~client ();
161
162 int read_packet (); // returns length of packet or 0
163 void skip_packet (int len); // we have processed the packet, skip it
164
165 void flush ();
166 void write_outputbuffer ();
167 void send (void *buf_, int len);
168
169 void send_packet (const char *buf);
170 void send_packet (const char *buf, int len);
171 void send_packet (packet &sl);
172}; 294};
173 295
174#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ 296#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
175 ( ((__type)>0) &&\ 297 ( ((__type)>0) &&\
176 ((__sockPtr)->has_readable_type) && \ 298 ((__sockPtr)->has_readable_type) && \
177 ((__sockPtr)->supported_readables & (1<<(__type))) ) 299 ((__sockPtr)->supported_readables & (1<<(__type))) )
178
179/* Bitmask for the faces_sent[] array - what
180 * portion of the face have we sent?
181 */
182#define NS_FACESENT_FACE 0x1
183#define NS_FACESENT_SMOOTH 0x2
184 300
185/* Constants in the form EMI_ is for extended map infos. 301/* Constants in the form EMI_ is for extended map infos.
186 * Even if the client select the additionnal infos it wants 302 * Even if the client select the additionnal infos it wants
187 * on the map, there may exist cases where this whole info 303 * on the map, there may exist cases where this whole info
188 * is not given in one buch but in separate bunches. This 304 * is not given in one buch but in separate bunches. This
… …
210 326
211#define FACE_TYPES 1 327#define FACE_TYPES 1
212#define PNG_FACE_INDEX 0 328#define PNG_FACE_INDEX 0
213 329
214#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ 330#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
215#define VERSION_SC 1027 331#define VERSION_SC 1026
332//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
216#define VERSION_INFO "Crossfire+ Server" 333#define VERSION_INFO "Crossfire TRT Server"
217 334
218typedef unordered_vector<client *> sockvec; 335typedef object_vector<client, &client::active> sockvec;
219 336
220extern sockvec clients; 337extern sockvec clients;
221extern int nrofpixmaps; //TODO: hrmpf, should go 338
339#define for_all_clients(var) \
340 for (int _i = 0; _i < clients.size (); ++_i) \
341 statementvar (client *, var, clients [_i])
222 342
223#endif 343#endif
224 344

Diff Legend

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