1 | |
|
|
2 | /* |
1 | /* |
3 | CrossFire, A Multiplayer game for the X Window System |
2 | CrossFire, A Multiplayer game for the X Window System |
4 | |
3 | |
5 | Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
4 | Copyright (C) 2002 Mark Wedel & Crossfire Development Team |
6 | Copyright (C) 1992 Frank Tore Johansen |
5 | Copyright (C) 1992 Frank Tore Johansen |
… | |
… | |
20 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
19 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
21 | |
20 | |
22 | The author can be reached via e-mail to crossfire@schmorp.de |
21 | The author can be reached via e-mail to crossfire@schmorp.de |
23 | */ |
22 | */ |
24 | |
23 | |
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 | |
|
|
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 | |
41 | struct MapCell |
34 | struct MapCell |
42 | { |
35 | { |
43 | UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient |
36 | UUID 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 */ |
… | |
… | |
75 | * current state. we set up our on buffers for sending/receiving, so we can |
68 | * 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 |
69 | * handle some higher level functions. fd is the actual file descriptor we |
77 | * are using. |
70 | * are using. |
78 | */ |
71 | */ |
79 | |
72 | |
80 | enum Sock_Status { Ns_Add, Ns_Dead }; |
|
|
81 | |
|
|
82 | /* Only one map mode can actually be used, so lets make it a switch |
73 | /* 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 |
74 | * instead of having a bunch of different fields that needed to |
84 | * get toggled. |
75 | * get toggled. |
85 | */ |
76 | */ |
86 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
77 | enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 }; |
87 | |
78 | |
88 | /* The following is the setup for a ring buffer for storing outbut |
79 | /* The following is the setup for a ring buffer for storing output |
89 | * data that the OS can't handle right away. |
80 | * data that the OS can't handle right away. |
90 | */ |
81 | */ |
91 | |
|
|
92 | struct Buffer |
82 | struct Buffer |
93 | { |
83 | { |
94 | char data[SOCKETBUFSIZE]; |
84 | char data[SOCKETBUFSIZE]; |
95 | int start; |
85 | int start; |
96 | int len; |
86 | int len; |
97 | }; |
87 | }; |
98 | |
88 | |
|
|
89 | // states the socket can be in |
|
|
90 | enum { |
|
|
91 | ST_DEAD, // socket is dead |
|
|
92 | ST_SETUP, // initial handshake / setup / login |
|
|
93 | ST_PLAYING, // logged in an playing |
|
|
94 | ST_CUSTOM, // waiting for custom reply |
|
|
95 | |
|
|
96 | ST_CONFIRM_QUIT, |
|
|
97 | ST_CHANGE_CLASS, |
|
|
98 | ST_GET_PARTY_PASSWORD, |
|
|
99 | }; |
|
|
100 | |
|
|
101 | // a handler for a specific type of packet |
|
|
102 | enum { |
|
|
103 | PF_PLAYER = 0x01, // must have valid player / will by synchronised |
|
|
104 | PF_PLAYING = 0x02, // must be in playing state |
|
|
105 | }; |
|
|
106 | |
|
|
107 | struct packet_type |
|
|
108 | { |
|
|
109 | const char *name; |
|
|
110 | void *cb; |
|
|
111 | int flags; |
|
|
112 | }; |
|
|
113 | |
|
|
114 | struct command |
|
|
115 | { |
|
|
116 | tstamp stamp; |
|
|
117 | const packet_type *handler; |
|
|
118 | char *data; |
|
|
119 | int datalen; |
|
|
120 | |
|
|
121 | ~command () |
|
|
122 | { |
|
|
123 | sfree<char> (data, datalen + 1); |
|
|
124 | } |
|
|
125 | }; |
|
|
126 | |
|
|
127 | struct refitem |
|
|
128 | { |
|
|
129 | object_ptr op; |
|
|
130 | }; |
|
|
131 | |
|
|
132 | // this represents a container on the client side. |
|
|
133 | // right now, there are only ever two of them: |
|
|
134 | // the inventory and the floor/open container |
|
|
135 | //TODO: unused as of yet |
|
|
136 | struct client_container : vector< refitem, slice_allocator<refitem> > |
|
|
137 | { |
|
|
138 | client *ns; |
|
|
139 | enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type; |
|
|
140 | |
|
|
141 | bool item_changed; // one of the items in here possibly changed |
|
|
142 | |
|
|
143 | // for mapspace and container |
|
|
144 | int x, y; |
|
|
145 | maptile *map; |
|
|
146 | |
|
|
147 | // for container |
|
|
148 | object *env; |
|
|
149 | |
|
|
150 | client_container (client *ns) |
|
|
151 | : ns (ns), type (CC_NONE) { } |
|
|
152 | |
|
|
153 | tag_t tag () const; |
|
|
154 | |
|
|
155 | inline iterator merge_item (iterator i, object *op); |
|
|
156 | |
|
|
157 | void clear (); |
|
|
158 | void update (); |
|
|
159 | |
|
|
160 | void set_mapspace (maptile *map, int x, int y); |
|
|
161 | void set_container (object *env); |
|
|
162 | }; |
|
|
163 | |
99 | /* how many times we are allowed to give the wrong password before being kicked. */ |
164 | /* how many times we are allowed to give the wrong password before being kicked. */ |
100 | #define MAX_PASSWORD_FAILURES 5 |
165 | #define MAX_PASSWORD_FAILURES 5 |
101 | |
166 | |
102 | ACC_CLASS (client) // should become player when newsocket is a baseclass of player |
167 | INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player |
103 | struct client : zero_initialised, attachable_base |
168 | struct client : zero_initialised, attachable |
104 | { |
169 | { |
105 | enum Sock_Status status; |
|
|
106 | int ACC (RW, fd); |
170 | int ACC (RW, fd); |
107 | unsigned int inbuf_len; // number of bytes valid in inbuf |
171 | 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 */ |
172 | uint8 *faces_sent; // This is a bitmap on sent face status |
111 | uint8 anims_sent[MAXANIMNUM]; |
|
|
112 | struct statsinfo stats; |
173 | statsinfo stats; |
|
|
174 | |
|
|
175 | client_container cc_inv, cc_other; |
|
|
176 | Buffer outputbuffer; |
113 | |
177 | |
114 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
178 | char *ACC (RW, host); /* Which host it is connected from (ip address) */ |
|
|
179 | uint8 ACC (RW, state); /* Input state of the player (name, password, etc */ |
115 | uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ |
180 | uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */ |
116 | Buffer outputbuffer; /* For undeliverable data */ |
|
|
117 | |
181 | |
|
|
182 | bool ACC (RW, afk); /* player is afk */ |
118 | bool ACC (RW, facecache); /* If true, client is caching images */ |
183 | bool ACC (RW, facecache); /* If true, client is caching images */ |
119 | bool ACC (RW, sent_scroll); |
184 | bool ACC (RW, sent_scroll); |
120 | bool ACC (RW, sound); /* does the client want sound */ |
185 | 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 */ |
186 | 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 */ |
187 | bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */ |
124 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
188 | bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */ |
125 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
189 | bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */ |
126 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
190 | bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */ |
127 | bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ |
191 | bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */ |
128 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
192 | bool ACC (RW, darkness); /* True if client wants darkness information */ |
129 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
193 | bool ACC (RW, image2); /* Client wants image2/face2 commands */ |
130 | bool ACC (RW, update_look); /* If true, we need to send the look window */ |
194 | 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 */ |
195 | bool ACC (RW, has_readable_type); /* If true client accept additional text information */ |
132 | /* used to arrange text in books, scrolls, or scripted dialogs */ |
196 | /* 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 */ |
197 | 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 */ |
198 | bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */ |
135 | /* Below are flags for extedend infos to pass to client |
199 | /* Below are flags for extedend infos to pass to client |
136 | * with S->C mapextended command */ |
200 | * with S->C mapextended command */ |
137 | bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
201 | bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */ |
138 | |
202 | |
139 | uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */ |
203 | 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 */ |
204 | uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */ |
141 | enum MapMode mapmode; /* Type of map commands the client wants. */ |
205 | enum MapMode mapmode; /* Type of map commands the client wants. */ |
142 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
206 | uint16 ACC (RW, look_position); /* start of drawing of look window */ |
… | |
… | |
144 | uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */ |
208 | 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 */ |
209 | uint8 ACC (RW, faceset); /* Set the client is using, default 0 */ |
146 | |
210 | |
147 | maptile *ACC (RW, current_map); // CF+ last/current player map |
211 | maptile *ACC (RW, current_map); // CF+ last/current player map |
148 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
212 | int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position |
149 | char ACC (RW, version)[64]; // CF+ client name/version |
213 | char ACC (RW, version)[64]; // CF+ client name/version |
150 | |
214 | |
151 | /* If we get an incomplete packet, this is used to hold the data. */ |
215 | player_ptr ACC (RO, pl); |
152 | uint8 inbuf[MAXSOCKBUF]; |
|
|
153 | player *ACC (RO, pl);//TODO should not be here, preferably |
|
|
154 | |
216 | |
155 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
217 | int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */ |
156 | |
|
|
157 | iow socket_ev; void socket_cb (iow &w, int got); |
|
|
158 | |
218 | |
159 | client (int fd, const char *from_ip); |
219 | client (int fd, const char *from_ip); |
160 | ~client (); |
220 | ~client (); |
|
|
221 | void do_destroy (); |
|
|
222 | void gather_callbacks (AV *&callbacks, event_type event) const; |
161 | |
223 | |
|
|
224 | iw cmd_ev; void cmd_cb (iw &w); |
|
|
225 | iow socket_ev; void socket_cb (iow &w, int got); |
|
|
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 | // if we get an incomplete packet, this is used to hold the data. |
|
|
233 | // we add 2 byte for the header, one for the trailing 0 byte |
|
|
234 | uint8 inbuf[MAXSOCKBUF + 2 + 1]; |
|
|
235 | |
|
|
236 | bool may_execute (const packet_type *pkt) const; |
|
|
237 | void execute (const packet_type *pkt, char *data, int datalen); |
|
|
238 | |
|
|
239 | void queue_command (packet_type *handler, char *data, int datalen); |
|
|
240 | bool handle_command (); |
|
|
241 | // resets movement state |
|
|
242 | void reset_state (); |
|
|
243 | |
|
|
244 | bool handle_packet (); |
162 | int read_packet (); // returns length of packet or 0 |
245 | int next_packet (); // returns length of packet or 0 |
163 | void skip_packet (int len); // we have processed the packet, skip it |
246 | void skip_packet (int len); // we have processed the packet, skip it |
164 | |
247 | |
165 | void flush (); |
248 | void flush (); |
166 | void write_outputbuffer (); |
249 | void write_outputbuffer (); |
167 | void send (void *buf_, int len); |
250 | void send (void *buf_, int len); |
168 | |
251 | |
169 | void send_packet (const char *buf); |
252 | void send_packet (const char *buf); |
170 | void send_packet (const char *buf, int len); |
253 | void send_packet (const char *buf, int len); |
|
|
254 | void send_packet_printf (const char *format, ...); |
171 | void send_packet (packet &sl); |
255 | void send_packet (packet &sl); |
|
|
256 | |
|
|
257 | // called when something under the player changes |
|
|
258 | void floorbox_update () { update_look = 1; } |
|
|
259 | // called when the player has been moved |
|
|
260 | void floorbox_reset () { look_position = 0; floorbox_update (); } |
|
|
261 | |
|
|
262 | static client *create (int fd, const char *peername); |
172 | }; |
263 | }; |
173 | |
264 | |
174 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
265 | #define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\ |
175 | ( ((__type)>0) &&\ |
266 | ( ((__type)>0) &&\ |
176 | ((__sockPtr)->has_readable_type) && \ |
267 | ((__sockPtr)->has_readable_type) && \ |