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 |
uint16 faces[MAP_LAYERS]; |
40 |
uint16 smooth[MAP_LAYERS]; |
41 |
unsigned char stat_hp; // health of something in this space, or 0 |
42 |
unsigned char flags; |
43 |
}; |
44 |
|
45 |
/* This basically defines the largest size an |
46 |
* archetype may be - it is used for allocation of |
47 |
* some structures, as well as determining how far |
48 |
* we should look for the heads of big images. |
49 |
*/ |
50 |
#define MAX_HEAD_OFFSET 8 |
51 |
|
52 |
#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) |
53 |
#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) |
54 |
|
55 |
struct Map |
56 |
{ |
57 |
struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
58 |
}; |
59 |
|
60 |
/* True max is 16383 given current map compaction method */ |
61 |
# define MAXANIMNUM 2000 |
62 |
|
63 |
struct statsinfo |
64 |
{ |
65 |
char *range, *title; |
66 |
}; |
67 |
|
68 |
/* This contains basic information on the socket structure. status is its |
69 |
* current state. we set up our on buffers for sending/receiving, so we can |
70 |
* handle some higher level functions. fd is the actual file descriptor we |
71 |
* are using. |
72 |
*/ |
73 |
|
74 |
/* Only one map mode can actually be used, so lets make it a switch |
75 |
* instead of having a bunch of different fields that needed to |
76 |
* get toggled. |
77 |
*/ |
78 |
enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
79 |
|
80 |
/* The following is the setup for a ring buffer for storing output |
81 |
* data that the OS can't handle right away. |
82 |
*/ |
83 |
struct Buffer |
84 |
{ |
85 |
char data[SOCKETBUFSIZE]; |
86 |
int start; |
87 |
int len; |
88 |
}; |
89 |
|
90 |
// states the socket can be in |
91 |
enum { |
92 |
ST_DEAD, // socket is dead |
93 |
ST_SETUP, // initial handshake / setup / login |
94 |
ST_PLAYING, // logged in an playing |
95 |
ST_CUSTOM, // waiting for custom reply |
96 |
|
97 |
ST_CONFIRM_QUIT, |
98 |
ST_CHANGE_CLASS, |
99 |
ST_GET_PARTY_PASSWORD, |
100 |
}; |
101 |
|
102 |
// a handler for a specific type of packet |
103 |
enum { |
104 |
PF_PLAYER = 0x01, // must have valid player / will by synchronised |
105 |
PF_PLAYING = 0x02, // must be in playing state |
106 |
}; |
107 |
|
108 |
struct packet_type |
109 |
{ |
110 |
const char *name; |
111 |
void *cb; |
112 |
int flags; |
113 |
}; |
114 |
|
115 |
struct command |
116 |
{ |
117 |
tstamp stamp; |
118 |
const packet_type *handler; |
119 |
char *data; |
120 |
int datalen; |
121 |
|
122 |
~command () |
123 |
{ |
124 |
sfree<char> (data, datalen + 1); |
125 |
} |
126 |
}; |
127 |
|
128 |
struct refitem |
129 |
{ |
130 |
object_ptr op; |
131 |
}; |
132 |
|
133 |
// this represents a container on the client side. |
134 |
// right now, there are only ever two of them: |
135 |
// the inventory and the floor/open container |
136 |
//TODO: unused as of yet |
137 |
struct client_container : vector< refitem, slice_allocator<refitem> > |
138 |
{ |
139 |
client *ns; |
140 |
enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type; |
141 |
|
142 |
bool item_changed; // one of the items in here possibly changed |
143 |
|
144 |
// for mapspace and container |
145 |
int x, y; |
146 |
maptile *map; |
147 |
|
148 |
// for container |
149 |
object *env; |
150 |
|
151 |
client_container (client *ns) |
152 |
: ns (ns), type (CC_NONE) { } |
153 |
|
154 |
tag_t tag () const; |
155 |
|
156 |
inline iterator merge_item (iterator i, object *op); |
157 |
|
158 |
void clear (); |
159 |
void update (); |
160 |
|
161 |
void set_mapspace (maptile *map, int x, int y); |
162 |
void set_container (object *env); |
163 |
}; |
164 |
|
165 |
/* how many times we are allowed to give the wrong password before being kicked. */ |
166 |
#define MAX_PASSWORD_FAILURES 5 |
167 |
|
168 |
INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
169 |
struct client : zero_initialised, attachable |
170 |
{ |
171 |
int ACC (RW, fd); |
172 |
unsigned int inbuf_len; // number of bytes valid in inbuf |
173 |
uint8 *faces_sent; // This is a bitmap on sent face status |
174 |
statsinfo stats; |
175 |
|
176 |
client_container cc_inv, cc_other; |
177 |
Buffer outputbuffer; |
178 |
|
179 |
char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
180 |
uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
181 |
uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ |
182 |
|
183 |
bool ACC (RW, afk); /* player is afk */ |
184 |
bool ACC (RW, facecache); /* If true, client is caching images */ |
185 |
bool ACC (RW, sent_scroll); |
186 |
bool ACC (RW, sound); /* does the client want sound */ |
187 |
bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
188 |
bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
189 |
bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
190 |
bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
191 |
bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
192 |
bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ |
193 |
bool ACC (RW, darkness); /* True if client wants darkness information */ |
194 |
bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
195 |
bool ACC (RW, update_look); /* If true, we need to send the look window */ |
196 |
bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
197 |
/* used to arrange text in books, scrolls, or scripted dialogs */ |
198 |
bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
199 |
bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
200 |
/* Below are flags for extedend infos to pass to client |
201 |
* with S->C mapextended command */ |
202 |
bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
203 |
|
204 |
uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
205 |
uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
206 |
enum MapMode mapmode; /* Type of map commands the client wants. */ |
207 |
uint16 ACC (RW, look_position); /* start of drawing of look window */ |
208 |
uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
209 |
uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
210 |
uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ |
211 |
|
212 |
maptile *ACC (RW, current_map); // CF+ last/current player map |
213 |
int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
214 |
char ACC (RW, version)[64]; // CF+ client name/version |
215 |
|
216 |
player_ptr ACC (RO, pl); |
217 |
|
218 |
int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
219 |
|
220 |
void do_destroy (); |
221 |
void gather_callbacks (AV *&callbacks, event_type event) const; |
222 |
|
223 |
iw cmd_ev; void cmd_cb (iw &w); |
224 |
iow socket_ev; void socket_cb (iow &w, int got); |
225 |
|
226 |
std::deque< command, slice_allocator<command> > cmd_queue; |
227 |
|
228 |
// large structures at the end please |
229 |
struct Map lastmap; |
230 |
std::bitset<MAXANIMNUM> anims_sent; |
231 |
// if we get an incomplete packet, this is used to hold the data. |
232 |
// we add 2 byte for the header, one for the trailing 0 byte |
233 |
uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
234 |
|
235 |
bool may_execute (const packet_type *pkt) const; |
236 |
void execute (const packet_type *pkt, char *data, int datalen); |
237 |
|
238 |
void queue_command (packet_type *handler, char *data, int datalen); |
239 |
MTH bool handle_command (); |
240 |
// resets movement state |
241 |
MTH void reset_state (); |
242 |
|
243 |
MTH bool handle_packet (); |
244 |
int next_packet (); // returns length of packet or 0 |
245 |
void skip_packet (int len); // we have processed the packet, skip it |
246 |
|
247 |
MTH void flush (); |
248 |
MTH void write_outputbuffer (); |
249 |
void send (void *buf_, int len); |
250 |
|
251 |
void send_packet (const char *buf); |
252 |
void send_packet (const char *buf, int len); |
253 |
void send_packet_printf (const char *format, ...); |
254 |
void send_packet (packet &sl); |
255 |
|
256 |
// called when something under the player changes |
257 |
MTH void floorbox_update () { update_look = 1; } |
258 |
// called when the player has been moved |
259 |
MTH void floorbox_reset () { look_position = 0; floorbox_update (); } |
260 |
|
261 |
MTH static client *create (int fd, const char *peername); |
262 |
|
263 |
protected: |
264 |
client (int fd, const char *from_ip); |
265 |
~client (); |
266 |
}; |
267 |
|
268 |
#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
269 |
( ((__type)>0) &&\ |
270 |
((__sockPtr)->has_readable_type) && \ |
271 |
((__sockPtr)->supported_readables & (1<<(__type))) ) |
272 |
|
273 |
/* Bitmask for the faces_sent[] array - what |
274 |
* portion of the face have we sent? |
275 |
*/ |
276 |
#define NS_FACESENT_FACE 0x1 |
277 |
#define NS_FACESENT_SMOOTH 0x2 |
278 |
|
279 |
/* Constants in the form EMI_ is for extended map infos. |
280 |
* Even if the client select the additionnal infos it wants |
281 |
* on the map, there may exist cases where this whole info |
282 |
* is not given in one buch but in separate bunches. This |
283 |
* is done performance reasons (imagine some info related to |
284 |
* a visible object and another info related to a 4 square |
285 |
* width and height area). At the begin of an extended info packet |
286 |
* is a bit field. A bit is activated for each extended info |
287 |
* present in the data |
288 |
*/ |
289 |
|
290 |
/* Meanings: |
291 |
* EMI_NOREDRAW Take extended infos into account but don't redraw, |
292 |
* some additionnal datas will follow in a new packet |
293 |
* EMI_SMOOTH Datas about smoothing |
294 |
*/ |
295 |
#define EMI_NOREDRAW 0x01 |
296 |
#define EMI_SMOOTH 0x02 |
297 |
|
298 |
/* this last one says the bitfield continue un next byte |
299 |
* There may be several on contiguous bytes. So there is 7 |
300 |
* actual bits used per byte, and the number of bytes |
301 |
* is not fixed in protocol |
302 |
*/ |
303 |
#define EMI_HASMOREBITS 0x80 |
304 |
|
305 |
#define FACE_TYPES 1 |
306 |
#define PNG_FACE_INDEX 0 |
307 |
|
308 |
#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
309 |
#define VERSION_SC 1027 |
310 |
#define VERSION_INFO "Crossfire+ Server" |
311 |
|
312 |
typedef unordered_vector<client *> sockvec; |
313 |
|
314 |
extern sockvec clients; |
315 |
extern int nrofpixmaps; //TODO: hrmpf, should go |
316 |
|
317 |
#endif |
318 |
|