1 |
/* |
2 |
* CrossFire, A Multiplayer game for the X Window System |
3 |
* |
4 |
* Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
5 |
* Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
6 |
* Copyright (C) 1992 Frank Tore Johansen |
7 |
* |
8 |
* This program is free software; you can redistribute it and/or modify |
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 |
11 |
* (at your option) any later version. |
12 |
* |
13 |
* This program is distributed in the hope that it will be useful, |
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 |
* GNU General Public License for more details. |
17 |
* |
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 |
20 |
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
21 |
* |
22 |
* The author can be reached via e-mail to crossfire@schmorp.de |
23 |
*/ |
24 |
|
25 |
#ifndef CLIENT_H |
26 |
#define CLIENT_H |
27 |
|
28 |
#include <deque> |
29 |
#include <bitset> |
30 |
#include <tr1/unordered_set> |
31 |
|
32 |
// (possibly) max. number of objects "per page" in the ground container |
33 |
#define FLOORBOX_PAGESIZE 50 |
34 |
|
35 |
struct MapCell |
36 |
{ |
37 |
UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
38 |
int count; /* This is really darkness in the map1 command */ |
39 |
faceidx faces[MAP_LAYERS]; |
40 |
unsigned char stat_hp; // health of something in this space, or 0 |
41 |
unsigned char flags; |
42 |
uint8_t smooth[MAP_LAYERS]; |
43 |
}; |
44 |
|
45 |
#define MAX_CLIENT_X MAP_CLIENT_X |
46 |
#define MAX_CLIENT_Y MAP_CLIENT_Y |
47 |
|
48 |
struct Map |
49 |
{ |
50 |
struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
51 |
}; |
52 |
|
53 |
/* True max is 16383 given current map compaction method */ |
54 |
#define MAXANIMNUM 10000 |
55 |
|
56 |
struct statsinfo |
57 |
{ |
58 |
char *range, *title; |
59 |
}; |
60 |
|
61 |
/* This contains basic information on the socket structure. status is its |
62 |
* current state. we set up our on buffers for sending/receiving, so we can |
63 |
* handle some higher level functions. fd is the actual file descriptor we |
64 |
* are using. |
65 |
*/ |
66 |
|
67 |
/* Only one map mode can actually be used, so lets make it a switch |
68 |
* instead of having a bunch of different fields that needed to |
69 |
* get toggled. |
70 |
*/ |
71 |
enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
72 |
|
73 |
/* The following is the setup for a ring buffer for storing output |
74 |
* data that the OS can't handle right away. |
75 |
*/ |
76 |
struct Buffer |
77 |
{ |
78 |
char data[SOCKETBUFSIZE]; |
79 |
int start; |
80 |
int len; |
81 |
}; |
82 |
|
83 |
// states the socket can be in |
84 |
enum { |
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 |
|
94 |
// a handler for a specific type of packet |
95 |
enum { |
96 |
PF_PLAYER = 0x01, // must have valid player / will by synchronised |
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 |
100 |
}; |
101 |
|
102 |
struct packet_type |
103 |
{ |
104 |
const char *name; |
105 |
void *cb; |
106 |
int flags; |
107 |
}; |
108 |
|
109 |
struct command |
110 |
{ |
111 |
tstamp stamp; |
112 |
const packet_type *handler; |
113 |
char *data; |
114 |
int datalen; |
115 |
|
116 |
~command () |
117 |
{ |
118 |
sfree<char> (data, datalen + 1); |
119 |
} |
120 |
}; |
121 |
|
122 |
struct 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 |
131 |
struct 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 |
|
159 |
/* how many times we are allowed to give the wrong password before being kicked. */ |
160 |
#define MAX_PASSWORD_FAILURES 5 |
161 |
|
162 |
INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
163 |
struct client : zero_initialised, attachable |
164 |
{ |
165 |
int ACC (RW, fd); |
166 |
unsigned int inbuf_len; // number of bytes valid in inbuf |
167 |
statsinfo stats; |
168 |
int ACC (RO, active); |
169 |
|
170 |
Buffer outputbuffer; |
171 |
|
172 |
char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
173 |
uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
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, force_face0); // client workaround for buggy checksum calculation in gcfclient |
189 |
bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient |
190 |
bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload |
191 |
bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images |
192 |
|
193 |
bool ACC (RW, afk); /* player is afk */ |
194 |
bool ACC (RW, facecache); /* If true, client is caching images */ |
195 |
bool ACC (RW, sent_scroll); |
196 |
bool ACC (RW, sound); /* does the client want sound */ |
197 |
bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
198 |
bool ACC (RW, plugincmd); // extend the protocol through a plug-in */ |
199 |
bool ACC (RW, mapinfocmd); // return map info and send map change info |
200 |
bool ACC (RW, extcmd); // call into extensions/plugins |
201 |
bool ACC (RW, extmap); // extend map comamnd with extra data |
202 |
bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls |
203 |
bool ACC (RW, darkness); /* True if client wants darkness information */ |
204 |
bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
205 |
bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands |
206 |
bool ACC (RW, update_look); /* If true, we need to send the look window */ |
207 |
bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
208 |
/* used to arrange text in books, scrolls, or scripted dialogs */ |
209 |
bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
210 |
bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
211 |
/* Below are flags for extedend infos to pass to client |
212 |
* with S->C mapextended command */ |
213 |
bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
214 |
bool ACC (RW, smoothing); // cfplus-style smoothing |
215 |
|
216 |
bool ACC (RW, force_newmap); // force a newmap before next map update |
217 |
uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
218 |
uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
219 |
uint16 ACC (RW, look_position); /* start of drawing of look window */ |
220 |
uint16 ACC (RW, mss); // likely tcp maximum segment size |
221 |
uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */ |
222 |
uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
223 |
uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
224 |
|
225 |
maptile *ACC (RW, current_map); // CF+ last/current player map |
226 |
region *ACC (RW, current_region); // CF+ last/current player region |
227 |
int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
228 |
char ACC (RW, version)[64]; // CF+ client name/version |
229 |
uint8 ACC (RW, faceset); // CF+ selected faceset |
230 |
|
231 |
player_ptr ACC (RO, pl); |
232 |
|
233 |
int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
234 |
|
235 |
int ACC (RW, rate_avail); // current rate balance |
236 |
int ACC (RW, max_rate); // max. # of bytes to send per tick |
237 |
faceidx ACC (RW, scrub_idx); // which face to send next |
238 |
int ACC (RW, bg_scrub); // how many ticks till the next background face send |
239 |
|
240 |
faceidx partial_face; |
241 |
uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face |
242 |
std::vector<faceidx, slice_allocator<faceidx> > askface; // which faces have been requested by the client |
243 |
|
244 |
std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx |
245 |
MTH void flush_fx (); // send fx if required |
246 |
|
247 |
void do_destroy (); |
248 |
void gather_callbacks (AV *&callbacks, event_type event) const; |
249 |
|
250 |
iow socket_ev; void socket_cb (iow &w, int got); |
251 |
iw cmd_ev; void cmd_cb (iw &w); |
252 |
client_container cc_inv, cc_other; |
253 |
|
254 |
std::deque< command, slice_allocator<command> > cmd_queue; |
255 |
|
256 |
// large structures at the end please |
257 |
struct Map lastmap; |
258 |
std::bitset<MAXANIMNUM> anims_sent; |
259 |
std::bitset<MAX_FACES> faces_sent; |
260 |
|
261 |
// if we get an incomplete packet, this is used to hold the data. |
262 |
// we add 2 byte for the header, one for the trailing 0 byte |
263 |
uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
264 |
|
265 |
bool may_execute (const packet_type *pkt) const; |
266 |
void execute (const packet_type *pkt, char *data, int datalen); |
267 |
|
268 |
void queue_command (packet_type *handler, char *data, int datalen); |
269 |
MTH bool handle_command (); |
270 |
// resets movement state |
271 |
MTH void reset_state (); |
272 |
// resets variable data used to send stat diffs |
273 |
MTH void reset_stats (); |
274 |
|
275 |
MTH bool handle_packet (); |
276 |
int next_packet (); // returns length of packet or 0 |
277 |
void skip_packet (int len); // we have processed the packet, skip it |
278 |
|
279 |
MTH void flush (); |
280 |
MTH void write_outputbuffer (); |
281 |
MTH int outputbuffer_len () const { return outputbuffer.len; } |
282 |
void send (void *buf_, int len); |
283 |
|
284 |
void send_packet (const char *buf); |
285 |
void send_packet (const char *buf, int len); |
286 |
void send_packet_printf (const char *format, ...); |
287 |
void send_packet (packet &sl); |
288 |
|
289 |
void send_drawinfo (const char *msg, int flags = NDI_BLACK); |
290 |
MTH void send_face (faceidx facenum); |
291 |
MTH void send_image (faceidx facenum); |
292 |
MTH void send_faces (object *ob); |
293 |
MTH void send_animation (short anim_num); |
294 |
|
295 |
// called when something under the player changes |
296 |
MTH void floorbox_update () { update_look = 1; } |
297 |
// called when the player has been moved |
298 |
MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
299 |
|
300 |
MTH void tick (); // called every server tick to do housekeeping etc. |
301 |
|
302 |
MTH static client *create (int fd, const char *peername); |
303 |
|
304 |
protected: |
305 |
client (int fd, const char *from_ip); |
306 |
~client (); |
307 |
}; |
308 |
|
309 |
#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
310 |
( ((__type)>0) &&\ |
311 |
((__sockPtr)->has_readable_type) && \ |
312 |
((__sockPtr)->supported_readables & (1<<(__type))) ) |
313 |
|
314 |
/* Constants in the form EMI_ is for extended map infos. |
315 |
* Even if the client select the additionnal infos it wants |
316 |
* on the map, there may exist cases where this whole info |
317 |
* is not given in one buch but in separate bunches. This |
318 |
* is done performance reasons (imagine some info related to |
319 |
* a visible object and another info related to a 4 square |
320 |
* width and height area). At the begin of an extended info packet |
321 |
* is a bit field. A bit is activated for each extended info |
322 |
* present in the data |
323 |
*/ |
324 |
|
325 |
/* Meanings: |
326 |
* EMI_NOREDRAW Take extended infos into account but don't redraw, |
327 |
* some additionnal datas will follow in a new packet |
328 |
* EMI_SMOOTH Datas about smoothing |
329 |
*/ |
330 |
#define EMI_NOREDRAW 0x01 |
331 |
#define EMI_SMOOTH 0x02 |
332 |
|
333 |
/* this last one says the bitfield continue un next byte |
334 |
* There may be several on contiguous bytes. So there is 7 |
335 |
* actual bits used per byte, and the number of bytes |
336 |
* is not fixed in protocol |
337 |
*/ |
338 |
#define EMI_HASMOREBITS 0x80 |
339 |
|
340 |
#define FACE_TYPES 1 |
341 |
#define PNG_FACE_INDEX 0 |
342 |
|
343 |
#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
344 |
#define VERSION_SC 1026 |
345 |
//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible |
346 |
#define VERSION_INFO "Crossfire+ Server" |
347 |
|
348 |
typedef object_vector<client, &client::active> sockvec; |
349 |
|
350 |
extern sockvec clients; |
351 |
|
352 |
#define for_all_clients(var) \ |
353 |
for (int _i = 0; _i < clients.size (); ++_i) \ |
354 |
declvar (client *, var, clients [_i]) |
355 |
|
356 |
#endif |
357 |
|