1 |
/* |
2 |
CrossFire, A Multiplayer game for the X Window System |
3 |
|
4 |
Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
5 |
Copyright (C) 1992 Frank Tore Johansen |
6 |
|
7 |
This program 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 |
the Free Software Foundation; either version 2 of the License, or |
10 |
(at your option) any later version. |
11 |
|
12 |
This program is distributed in the hope that it will be useful, |
13 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 |
GNU General Public License for more details. |
16 |
|
17 |
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 |
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
20 |
|
21 |
The author can be reached via e-mail to crossfire@schmorp.de |
22 |
*/ |
23 |
|
24 |
#ifndef CLIENT_H |
25 |
#define CLIENT_H |
26 |
|
27 |
#include <deque> |
28 |
#include <bitset> |
29 |
|
30 |
// (possibly) max. number of objects "per page" in the ground container |
31 |
#define NUM_LOOK_OBJECTS 50 |
32 |
|
33 |
struct MapCell |
34 |
{ |
35 |
UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
36 |
int count; /* This is really darkness in the map1 command */ |
37 |
uint16 faces[MAP_LAYERS]; |
38 |
uint16 smooth[MAP_LAYERS]; |
39 |
unsigned char stat_hp; // health of something in this space, or 0 |
40 |
unsigned char flags; |
41 |
}; |
42 |
|
43 |
/* This basically defines the largest size an |
44 |
* archetype may be - it is used for allocation of |
45 |
* some structures, as well as determining how far |
46 |
* we should look for the heads of big images. |
47 |
*/ |
48 |
#define MAX_HEAD_OFFSET 8 |
49 |
|
50 |
#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET) |
51 |
#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET) |
52 |
|
53 |
struct Map |
54 |
{ |
55 |
struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y]; |
56 |
}; |
57 |
|
58 |
/* True max is 16383 given current map compaction method */ |
59 |
# define MAXANIMNUM 2000 |
60 |
|
61 |
struct statsinfo |
62 |
{ |
63 |
char *range, *title; |
64 |
}; |
65 |
|
66 |
/* This contains basic information on the socket structure. status is its |
67 |
* current state. we set up our on buffers for sending/receiving, so we can |
68 |
* handle some higher level functions. fd is the actual file descriptor we |
69 |
* are using. |
70 |
*/ |
71 |
|
72 |
enum Sock_Status { Ns_Add, Ns_Dead }; |
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 outbut |
81 |
* data that the OS can't handle right away. |
82 |
*/ |
83 |
|
84 |
struct Buffer |
85 |
{ |
86 |
char data[SOCKETBUFSIZE]; |
87 |
int start; |
88 |
int len; |
89 |
}; |
90 |
|
91 |
// a handler for a specific type of packet |
92 |
enum { |
93 |
PF_PLAYER = 0x01, // must have valid player / will by synchronised |
94 |
PF_PLAYING = 0x02, // must be in playing state |
95 |
}; |
96 |
|
97 |
struct packet_type |
98 |
{ |
99 |
const char *name; |
100 |
void *cb; |
101 |
int flags; |
102 |
}; |
103 |
|
104 |
struct command |
105 |
{ |
106 |
tstamp stamp; |
107 |
const packet_type *handler; |
108 |
char *data; |
109 |
int datalen; |
110 |
|
111 |
~command () |
112 |
{ |
113 |
sfree<char> (data, datalen + 1); |
114 |
} |
115 |
}; |
116 |
|
117 |
/* how many times we are allowed to give the wrong password before being kicked. */ |
118 |
#define MAX_PASSWORD_FAILURES 5 |
119 |
|
120 |
ACC_CLASS (client) // should become player when newsocket is a baseclass of player |
121 |
struct client : zero_initialised, attachable_base |
122 |
{ |
123 |
enum Sock_Status status; |
124 |
int ACC (RW, fd); |
125 |
unsigned int inbuf_len; // number of bytes valid in inbuf |
126 |
uint8 *faces_sent; // This is a bitmap on sent face status |
127 |
struct statsinfo stats; |
128 |
|
129 |
char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
130 |
uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ |
131 |
Buffer outputbuffer; |
132 |
|
133 |
bool ACC (RW, facecache); /* If true, client is caching images */ |
134 |
bool ACC (RW, sent_scroll); |
135 |
bool ACC (RW, sound); /* does the client want sound */ |
136 |
bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */ |
137 |
bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */ |
138 |
bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
139 |
bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
140 |
bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
141 |
bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
142 |
bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ |
143 |
bool ACC (RW, darkness); /* True if client wants darkness information */ |
144 |
bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
145 |
bool ACC (RW, update_look); /* If true, we need to send the look window */ |
146 |
bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
147 |
/* used to arrange text in books, scrolls, or scripted dialogs */ |
148 |
bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */ |
149 |
bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */ |
150 |
/* Below are flags for extedend infos to pass to client |
151 |
* with S->C mapextended command */ |
152 |
bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
153 |
|
154 |
uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
155 |
uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
156 |
enum MapMode mapmode; /* Type of map commands the client wants. */ |
157 |
uint16 ACC (RW, look_position); /* start of drawing of look window */ |
158 |
uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */ |
159 |
uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
160 |
uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ |
161 |
|
162 |
maptile *ACC (RW, current_map); // CF+ last/current player map |
163 |
int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
164 |
char ACC (RW, version)[64]; // CF+ client name/version |
165 |
|
166 |
player *ACC (RO, pl);//TODO should not be here, preferably |
167 |
|
168 |
int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
169 |
|
170 |
client (int fd, const char *from_ip); |
171 |
~client (); |
172 |
void destroy (); |
173 |
|
174 |
iw cmd_ev; void cmd_cb (iw &w); |
175 |
iow socket_ev; void socket_cb (iow &w, int got); |
176 |
|
177 |
std::deque< command, slice_allocator<command> > cmd_queue; |
178 |
|
179 |
// resets movement state |
180 |
bool may_execute (const packet_type *pkt) const; |
181 |
void execute (const packet_type *pkt, char *data, int datalen); |
182 |
|
183 |
void queue_command (packet_type *handler, char *data, int datalen); |
184 |
bool handle_command (); |
185 |
void reset_state (); |
186 |
|
187 |
bool handle_packet (); |
188 |
int next_packet (); // returns length of packet or 0 |
189 |
void skip_packet (int len); // we have processed the packet, skip it |
190 |
|
191 |
void flush (); |
192 |
void write_outputbuffer (); |
193 |
void send (void *buf_, int len); |
194 |
|
195 |
void send_packet (const char *buf); |
196 |
void send_packet (const char *buf, int len); |
197 |
void send_packet_printf (const char *format, ...); |
198 |
void send_packet (packet &sl); |
199 |
|
200 |
// large structures at the end please |
201 |
struct Map lastmap; |
202 |
std::bitset<MAXANIMNUM> anims_sent; |
203 |
// if we get an incomplete packet, this is used to hold the data. |
204 |
// we add 2 byte for the header, one for the trailing 0 byte |
205 |
uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
206 |
|
207 |
}; |
208 |
|
209 |
#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
210 |
( ((__type)>0) &&\ |
211 |
((__sockPtr)->has_readable_type) && \ |
212 |
((__sockPtr)->supported_readables & (1<<(__type))) ) |
213 |
|
214 |
/* Bitmask for the faces_sent[] array - what |
215 |
* portion of the face have we sent? |
216 |
*/ |
217 |
#define NS_FACESENT_FACE 0x1 |
218 |
#define NS_FACESENT_SMOOTH 0x2 |
219 |
|
220 |
/* Constants in the form EMI_ is for extended map infos. |
221 |
* Even if the client select the additionnal infos it wants |
222 |
* on the map, there may exist cases where this whole info |
223 |
* is not given in one buch but in separate bunches. This |
224 |
* is done performance reasons (imagine some info related to |
225 |
* a visible object and another info related to a 4 square |
226 |
* width and height area). At the begin of an extended info packet |
227 |
* is a bit field. A bit is activated for each extended info |
228 |
* present in the data |
229 |
*/ |
230 |
|
231 |
/* Meanings: |
232 |
* EMI_NOREDRAW Take extended infos into account but don't redraw, |
233 |
* some additionnal datas will follow in a new packet |
234 |
* EMI_SMOOTH Datas about smoothing |
235 |
*/ |
236 |
#define EMI_NOREDRAW 0x01 |
237 |
#define EMI_SMOOTH 0x02 |
238 |
|
239 |
/* this last one says the bitfield continue un next byte |
240 |
* There may be several on contiguous bytes. So there is 7 |
241 |
* actual bits used per byte, and the number of bytes |
242 |
* is not fixed in protocol |
243 |
*/ |
244 |
#define EMI_HASMOREBITS 0x80 |
245 |
|
246 |
#define FACE_TYPES 1 |
247 |
#define PNG_FACE_INDEX 0 |
248 |
|
249 |
#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */ |
250 |
#define VERSION_SC 1027 |
251 |
#define VERSION_INFO "Crossfire+ Server" |
252 |
|
253 |
typedef unordered_vector<client *> sockvec; |
254 |
|
255 |
extern sockvec clients; |
256 |
extern int nrofpixmaps; //TODO: hrmpf, should go |
257 |
|
258 |
#endif |
259 |
|