server/include/client.h

/*
    CrossFire, A Multiplayer game for the X Window System

    Copyright (C) 2002 Mark Wedel & Crossfire Development Team
    Copyright (C) 1992 Frank Tore Johansen

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    The author can be reached via e-mail to crossfire@schmorp.de
*/

#ifndef CLIENT_H
#define CLIENT_H

#include <deque>
#include <bitset>
#include <tr1/unordered_set>

// (possibly) max. number of objects "per page" in the ground container
#define FLOORBOX_PAGESIZE 50

struct MapCell
{
  UUID player;                 // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
  int count;                    /* This is really darkness in the map1 command */
  uint16 faces[MAP_LAYERS];
  uint16 smooth[MAP_LAYERS];
  unsigned char stat_hp;        // health of something in this space, or 0
  unsigned char flags;
};

/* This basically defines the largest size an 
 * archetype may be - it is used for allocation of
 * some structures, as well as determining how far
 * we should look for the heads of big images.
 */
#define MAX_HEAD_OFFSET     8

#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET)
#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET)

struct Map
{
  struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
};

/* True max is 16383 given current map compaction method */
# define MAXANIMNUM  2000

struct statsinfo
{
  char *range, *title;
};

/* This contains basic information on the socket structure.  status is its
 * current state.  we set up our on buffers for sending/receiving, so we can
 * handle some higher level functions.  fd is the actual file descriptor we
 * are using.
 */

/* Only one map mode can actually be used, so lets make it a switch
 * instead of having a bunch of different fields that needed to
 * get toggled.
 */
enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };

/* The following is the setup for a ring buffer for storing output
 * data that the OS can't handle right away.
 */
struct Buffer
{
  char data[SOCKETBUFSIZE];
  int start;
  int len;
};

// states the socket can be in
enum {
 ST_DEAD,     // socket is dead
 ST_SETUP,    // initial handshake / setup / login
 ST_PLAYING,  // logged in an playing
 ST_CUSTOM,   // waiting for custom reply

 ST_CONFIRM_QUIT,
 ST_CHANGE_CLASS,
 ST_GET_PARTY_PASSWORD,
};

// a handler for a specific type of packet
enum {
  PF_PLAYER    = 0x01, // must have valid player / will by synchronised
  PF_PLAYING   = 0x02, // must be in playing state
};

struct packet_type
{
  const char *name;
  void *cb;
  int flags;
};

struct command
{
  tstamp stamp;
  const packet_type *handler;
  char *data;
  int datalen;

  ~command ()
  {
    sfree<char> (data, datalen + 1);
  }
};

struct refitem
{
  object_ptr op;
};

// this represents a container on the client side.
// right now, there are only ever two of them:
// the inventory and the floor/open container
//TODO: unused as of yet
struct client_container : vector< refitem, slice_allocator<refitem> >
{
  client *ns;
  enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;

  bool item_changed; // one of the items in here possibly changed

  // for mapspace and container
  int x, y;
  maptile *map;

  // for container
  object *env;

  client_container (client *ns)
  : ns (ns), type (CC_NONE) { }

  tag_t tag () const;

  inline iterator merge_item (iterator i, object *op);

  void clear ();
  void update ();

  void set_mapspace (maptile *map, int x, int y);
  void set_container (object *env);
};

/* how many times we are allowed to give the wrong password before being kicked. */
#define MAX_PASSWORD_FAILURES 5

INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
struct client : zero_initialised, attachable
{
  int ACC (RW, fd);
  unsigned int inbuf_len;                 // number of bytes valid in inbuf
  uint8 *faces_sent;                      // This is a bitmap on sent face status
  statsinfo stats;

  client_container cc_inv, cc_other;
  Buffer outputbuffer;                    

  char *ACC (RW, host);                   /* Which host it is connected from (ip address) */
  uint8 ACC (RW, state);                  /* Input state of the player (name, password, etc */
  uint8 ACC (RW, password_fails);         /* how many times the player has failed to give the right password */

  bool ACC (RW, afk);                     /* player is afk */
  bool ACC (RW, facecache);               /* If true, client is caching images */
  bool ACC (RW, sent_scroll);             
  bool ACC (RW, sound);                   /* does the client want sound */
  bool ACC (RW, newmapcmd);               /* Send newmap command when entering new map SMACFIGGEN */
  bool ACC (RW, plugincmd);               /* CF+ extend the protocol through a plug-in */
  bool ACC (RW, mapinfocmd);              /* CF+ return map info and send map change info */
  bool ACC (RW, extcmd);                  /* CF+ call into extensions/plugins */
  bool ACC (RW, extmap);                  /* CF+ extend map comamnd with extra data */
  bool ACC (RW, buggy_mapscroll);         /* CF+ client crashes on large mapscrolls */
  bool ACC (RW, darkness);                /* True if client wants darkness information */
  bool ACC (RW, image2);                  /* Client wants image2/face2 commands */
  bool ACC (RW, update_look);             /* If true, we need to send the look window */
  bool ACC (RW, has_readable_type);       /* If true client accept additional text information */
                                          /* used to arrange text in books, scrolls, or scripted dialogs */
  bool ACC (RW, monitor_spells);          /* Client wishes to be informed when their spell list changes */
  bool ACC (RW, ext_mapinfos);            /* If true client accepts additional info on maps */
                                          /* Below are flags for extedend infos to pass to client 
                                           * with S->C mapextended command */
  bool ACC (RW, EMI_smooth);              /* Send smooth in extendmapinfos */

  uint32 ACC (RW, supported_readables);   /* each bit is a readable supported by client */
  uint32 ACC (RW, cs_version), ACC (RW, sc_version);        /* versions of the client */
  enum MapMode mapmode;         /* Type of map commands the client wants. */
  uint16 ACC (RW, look_position);         /* start of drawing of look window */
  uint8 ACC (RW, mapx), ACC (RW, mapy);             /* How large a map the client wants */
  uint8 ACC (RW, itemcmd);                /* What version of the 'item' protocol command to use */
  uint8 ACC (RW, faceset);                /* Set the client is using, default 0 */

  maptile *ACC (RW, current_map);         // CF+ last/current player map
  int ACC (RW, current_x), ACC (RW, current_y);     // CF+ last/current map position
  char ACC (RW, version)[64];             // CF+ client name/version

  player_ptr ACC (RO, pl);

  int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */

  client (int fd, const char *from_ip);
  ~client ();
  void do_destroy ();
  void gather_callbacks (AV *&callbacks, event_type event) const;

  iw  cmd_ev;    void cmd_cb (iw &w);
  iow socket_ev; void socket_cb (iow &w, int got);

  std::deque< command, slice_allocator<command> > cmd_queue;

  // large structures at the end please
  struct Map lastmap;
  std::bitset<MAXANIMNUM> anims_sent;
  // if we get an incomplete packet, this is used to hold the data.
  // we add 2 byte for the header, one for the trailing 0 byte
  uint8 inbuf[MAXSOCKBUF + 2 + 1];

  bool may_execute (const packet_type *pkt) const;
  void execute (const packet_type *pkt, char *data, int datalen);

  void queue_command (packet_type *handler, char *data, int datalen);
  bool handle_command ();
  // resets movement state
  void reset_state ();

  bool handle_packet ();
  int next_packet ();                     // returns length of packet or 0
  void skip_packet (int len);             // we have processed the packet, skip it

  void flush ();
  void write_outputbuffer ();
  void send (void *buf_, int len);

  void send_packet (const char *buf);
  void send_packet (const char *buf, int len);
  void send_packet_printf (const char *format, ...);
  void send_packet (packet &sl);

  // called when something under the player changes
  void floorbox_update () { update_look = 1; }
  // called when the player has been moved
  void floorbox_reset  () { look_position = 0; floorbox_update (); }

  static client *create (int fd, const char *peername);
};

#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
        ( ((__type)>0) &&\
          ((__sockPtr)->has_readable_type) && \
          ((__sockPtr)->supported_readables & (1<<(__type))) )

/* Bitmask for the faces_sent[] array - what
 * portion of the face have we sent?
 */
#define NS_FACESENT_FACE        0x1
#define NS_FACESENT_SMOOTH      0x2

/* Constants in the form EMI_ is for extended map infos.
 * Even if the client select the additionnal infos it wants
 * on the map, there may exist cases where this whole info
 * is not given in one buch but in separate bunches. This 
 * is done performance reasons (imagine some info related to
 * a visible object and another info related to a 4 square
 * width and height area). At the begin of an extended info packet
 * is a bit field. A bit is activated for each extended info
 * present in the data 
 */

/* Meanings:
 * EMI_NOREDRAW  Take extended infos into account but don't redraw,
 *               some additionnal datas will follow in a new packet
 * EMI_SMOOTH    Datas about smoothing  
 */
#define EMI_NOREDRAW        0x01
#define EMI_SMOOTH          0x02

/* this last one says the bitfield continue un next byte
 * There may be several on contiguous bytes. So there is 7
 * actual bits used per byte, and the number of bytes
 * is not fixed in protocol
 */
#define EMI_HASMOREBITS     0x80

#define FACE_TYPES  1
#define PNG_FACE_INDEX  0

#define VERSION_CS 1023        /* version >= 1023 understand setup cmd */
#define VERSION_SC 1027
#define VERSION_INFO "Crossfire+ Server"

typedef unordered_vector<client *> sockvec;

extern sockvec clients;
extern int nrofpixmaps; //TODO: hrmpf, should go

#endif

Revision:	1.21
Committed:	Mon Dec 25 11:25:49 2006 UTC (17 years, 5 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.20:	+4 -4 lines
Log Message:	- small, but subtle, rewrite of object management - perl will now keep attachable objects alive - objects are now refcounted - refcouts need to be tested explicitly (refcnt_chk) - explicit destroy is required current - explicit destroy asks "nicely" for the object to self destruct, if possible - refcounts will be used during mortal killing - minor bugfixes, optimisations etc. - some former hacks removed.
#	Content
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	#include <tr1/unordered_set>
30
31	// (possibly) max. number of objects "per page" in the ground container
32	#define FLOORBOX_PAGESIZE 50
33
34	struct MapCell
35	{
36	UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
37	int count; /* This is really darkness in the map1 command */
38	uint16 faces[MAP_LAYERS];
39	uint16 smooth[MAP_LAYERS];
40	unsigned char stat_hp; // health of something in this space, or 0
41	unsigned char flags;
42	};
43
44	/* This basically defines the largest size an
45	* archetype may be - it is used for allocation of
46	* some structures, as well as determining how far
47	* we should look for the heads of big images.
48	*/
49	#define MAX_HEAD_OFFSET 8
50
51	#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET)
52	#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET)
53
54	struct Map
55	{
56	struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
57	};
58
59	/* True max is 16383 given current map compaction method */
60	# define MAXANIMNUM 2000
61
62	struct statsinfo
63	{
64	char range, title;
65	};
66
67	/* This contains basic information on the socket structure. status is its
68	* current state. we set up our on buffers for sending/receiving, so we can
69	* handle some higher level functions. fd is the actual file descriptor we
70	* are using.
71	*/
72
73	/* Only one map mode can actually be used, so lets make it a switch
74	* instead of having a bunch of different fields that needed to
75	* get toggled.
76	*/
77	enum MapMode { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
78
79	/* The following is the setup for a ring buffer for storing output
80	* data that the OS can't handle right away.
81	*/
82	struct Buffer
83	{
84	char data[SOCKETBUFSIZE];
85	int start;
86	int len;
87	};
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
164	/* how many times we are allowed to give the wrong password before being kicked. */
165	#define MAX_PASSWORD_FAILURES 5
166
167	INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
168	struct client : zero_initialised, attachable
169	{
170	int ACC (RW, fd);
171	unsigned int inbuf_len; // number of bytes valid in inbuf
172	uint8 *faces_sent; // This is a bitmap on sent face status
173	statsinfo stats;
174
175	client_container cc_inv, cc_other;
176	Buffer outputbuffer;
177
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 */
180	uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */
181
182	bool ACC (RW, afk); /* player is afk */
183	bool ACC (RW, facecache); /* If true, client is caching images */
184	bool ACC (RW, sent_scroll);
185	bool ACC (RW, sound); /* does the client want sound */
186	bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
187	bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
188	bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
189	bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
190	bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
191	bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
192	bool ACC (RW, darkness); /* True if client wants darkness information */
193	bool ACC (RW, image2); /* Client wants image2/face2 commands */
194	bool ACC (RW, update_look); /* If true, we need to send the look window */
195	bool ACC (RW, has_readable_type); /* If true client accept additional text information */
196	/* used to arrange text in books, scrolls, or scripted dialogs */
197	bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
198	bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
199	/* Below are flags for extedend infos to pass to client
200	* with S->C mapextended command */
201	bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
202
203	uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
204	uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
205	enum MapMode mapmode; /* Type of map commands the client wants. */
206	uint16 ACC (RW, look_position); /* start of drawing of look window */
207	uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
208	uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
209	uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
210
211	maptile *ACC (RW, current_map); // CF+ last/current player map
212	int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
213	char ACC (RW, version)[64]; // CF+ client name/version
214
215	player_ptr ACC (RO, pl);
216
217	int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
218
219	client (int fd, const char *from_ip);
220	~client ();
221	void do_destroy ();
222	void gather_callbacks (AV *&callbacks, event_type event) const;
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 ();
245	int next_packet (); // returns length of packet or 0
246	void skip_packet (int len); // we have processed the packet, skip it
247
248	void flush ();
249	void write_outputbuffer ();
250	void send (void *buf_, int len);
251
252	void send_packet (const char *buf);
253	void send_packet (const char *buf, int len);
254	void send_packet_printf (const char *format, ...);
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);
263	};
264
265	#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
266	( ((__type)>0) &&\
267	((__sockPtr)->has_readable_type) && \
268	((__sockPtr)->supported_readables & (1<<(__type))) )
269
270	/* Bitmask for the faces_sent[] array - what
271	* portion of the face have we sent?
272	*/
273	#define NS_FACESENT_FACE 0x1
274	#define NS_FACESENT_SMOOTH 0x2
275
276	/* Constants in the form EMI_ is for extended map infos.
277	* Even if the client select the additionnal infos it wants
278	* on the map, there may exist cases where this whole info
279	* is not given in one buch but in separate bunches. This
280	* is done performance reasons (imagine some info related to
281	* a visible object and another info related to a 4 square
282	* width and height area). At the begin of an extended info packet
283	* is a bit field. A bit is activated for each extended info
284	* present in the data
285	*/
286
287	/* Meanings:
288	* EMI_NOREDRAW Take extended infos into account but don't redraw,
289	* some additionnal datas will follow in a new packet
290	* EMI_SMOOTH Datas about smoothing
291	*/
292	#define EMI_NOREDRAW 0x01
293	#define EMI_SMOOTH 0x02
294
295	/* this last one says the bitfield continue un next byte
296	* There may be several on contiguous bytes. So there is 7
297	* actual bits used per byte, and the number of bytes
298	* is not fixed in protocol
299	*/
300	#define EMI_HASMOREBITS 0x80
301
302	#define FACE_TYPES 1
303	#define PNG_FACE_INDEX 0
304
305	#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
306	#define VERSION_SC 1027
307	#define VERSION_INFO "Crossfire+ Server"
308
309	typedef unordered_vector<client *> sockvec;
310
311	extern sockvec clients;
312	extern int nrofpixmaps; //TODO: hrmpf, should go
313
314	#endif
315