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_PLAY_AGAIN,
 ST_ROLL_STAT,
 ST_CHANGE_CLASS,
 ST_CONFIRM_QUIT,
 ST_CONFIGURE,
 ST_GET_NAME,
 ST_GET_PASSWORD,
 ST_CONFIRM_PASSWORD,
 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

ACC_CLASS (client) // should become player when newsocket is a baseclass of player
struct client : zero_initialised, attachable<client>
{
  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, facecache);               /* If true, client is caching images */
  bool ACC (RW, sent_scroll);             
  bool ACC (RW, sound);                   /* does the client want sound */
  bool ACC (RW, exp64);                   /* Client wants 64 bit exp data, as well as skill data */
  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 *ACC (RO, pl);//TODO should not be here, preferably

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

  client (int fd, const char *from_ip);
  ~client ();
  void destroy ();
  bool destroyed () const { return state == ST_DEAD; }

  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.15
Committed:	Thu Dec 21 23:37:05 2006 UTC (17 years, 5 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.14:	+21 -2 lines
Log Message:	- made state a per-client variable (that does not magically make state a per-client thing!) - rename player->socket to player->ns. its not a good name for "client", but it is an historical artifact, and better than "socket".
#	User	Rev	Content
1	root	1.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	root	1.3	The author can be reached via e-mail to crossfire@schmorp.de
22	root	1.1	*/
23
24			#ifndef CLIENT_H
25			#define CLIENT_H
26
27	root	1.4	#include <deque>
28	root	1.7	#include <bitset>
29	root	1.13	#include <tr1/unordered_set>
30	root	1.1
31	root	1.4	// (possibly) max. number of objects "per page" in the ground container
32	root	1.11	#define FLOORBOX_PAGESIZE 50
33	root	1.1
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	root	1.13	/* The following is the setup for a ring buffer for storing output
80	root	1.1	* data that the OS can't handle right away.
81			*/
82
83			struct Buffer
84			{
85			char data[SOCKETBUFSIZE];
86			int start;
87			int len;
88			};
89
90	root	1.15	// 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_PLAY_AGAIN,
98			ST_ROLL_STAT,
99			ST_CHANGE_CLASS,
100			ST_CONFIRM_QUIT,
101			ST_CONFIGURE,
102			ST_GET_NAME,
103			ST_GET_PASSWORD,
104			ST_CONFIRM_PASSWORD,
105			ST_GET_PARTY_PASSWORD,
106			};
107
108	root	1.4	// a handler for a specific type of packet
109			enum {
110	root	1.9	PF_PLAYER = 0x01, // must have valid player / will by synchronised
111			PF_PLAYING = 0x02, // must be in playing state
112	root	1.4	};
113
114			struct packet_type
115			{
116			const char *name;
117			void *cb;
118			int flags;
119			};
120
121			struct command
122			{
123			tstamp stamp;
124			const packet_type *handler;
125			char *data;
126			int datalen;
127
128	root	1.6	~command ()
129	root	1.4	{
130	root	1.8	sfree<char> (data, datalen + 1);
131	root	1.4	}
132			};
133
134	root	1.13	struct refitem
135			{
136			object_ptr op;
137			};
138
139	root	1.12	// this represents a container on the client side.
140			// right now, there are only ever two of them:
141			// the inventory and the floor/open container
142			//TODO: unused as of yet
143	root	1.13	struct client_container : vector< refitem, slice_allocator<refitem> >
144	root	1.12	{
145	root	1.13	client *ns;
146	root	1.12	enum { CC_NONE, CC_INVENTORY, CC_MAPSPACE, CC_CONTAINER } type;
147
148	root	1.13	bool item_changed; // one of the items in here possibly changed
149
150	root	1.12	// for mapspace and container
151	root	1.13	int x, y;
152	root	1.12	maptile *map;
153
154			// for container
155			object *env;
156	root	1.13
157			client_container (client *ns)
158			: ns (ns), type (CC_NONE) { }
159
160			tag_t tag () const;
161
162			inline iterator merge_item (iterator i, object *op);
163
164			void clear ();
165			void update ();
166
167			void set_mapspace (maptile *map, int x, int y);
168			void set_container (object *env);
169	root	1.12	};
170
171	root	1.1	/* how many times we are allowed to give the wrong password before being kicked. */
172			#define MAX_PASSWORD_FAILURES 5
173
174			ACC_CLASS (client) // should become player when newsocket is a baseclass of player
175	root	1.14	struct client : zero_initialised, attachable<client>
176	root	1.1	{
177			int ACC (RW, fd);
178	root	1.10	unsigned int inbuf_len; // number of bytes valid in inbuf
179			uint8 *faces_sent; // This is a bitmap on sent face status
180	root	1.12	statsinfo stats;
181
182			client_container cc_inv, cc_other;
183	root	1.15	Buffer outputbuffer;
184	root	1.10
185			char ACC (RW, host); / Which host it is connected from (ip address) */
186	root	1.15	uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
187	root	1.10	uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */
188
189			bool ACC (RW, facecache); /* If true, client is caching images */
190			bool ACC (RW, sent_scroll);
191			bool ACC (RW, sound); /* does the client want sound */
192			bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
193			bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
194			bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
195			bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
196			bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
197			bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
198			bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
199			bool ACC (RW, darkness); /* True if client wants darkness information */
200			bool ACC (RW, image2); /* Client wants image2/face2 commands */
201			bool ACC (RW, update_look); /* If true, we need to send the look window */
202			bool ACC (RW, has_readable_type); /* If true client accept additional text information */
203			/* used to arrange text in books, scrolls, or scripted dialogs */
204			bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
205			bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
206			/* Below are flags for extedend infos to pass to client
207			* with S->C mapextended command */
208			bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
209	root	1.1
210			uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
211			uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
212			enum MapMode mapmode; /* Type of map commands the client wants. */
213			uint16 ACC (RW, look_position); /* start of drawing of look window */
214			uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
215			uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
216			uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
217
218			maptile *ACC (RW, current_map); // CF+ last/current player map
219			int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
220	root	1.10	char ACC (RW, version)[64]; // CF+ client name/version
221	root	1.1
222			player *ACC (RO, pl);//TODO should not be here, preferably
223
224			int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
225
226	root	1.4	client (int fd, const char *from_ip);
227			~client ();
228			void destroy ();
229	root	1.15	bool destroyed () const { return state == ST_DEAD; }
230	root	1.4
231			iw cmd_ev; void cmd_cb (iw &w);
232	root	1.1	iow socket_ev; void socket_cb (iow &w, int got);
233
234	root	1.4	std::deque< command, slice_allocator<command> > cmd_queue;
235
236	root	1.14	// large structures at the end please
237			struct Map lastmap;
238			std::bitset<MAXANIMNUM> anims_sent;
239			// if we get an incomplete packet, this is used to hold the data.
240			// we add 2 byte for the header, one for the trailing 0 byte
241			uint8 inbuf[MAXSOCKBUF + 2 + 1];
242
243	root	1.4	bool may_execute (const packet_type *pkt) const;
244			void execute (const packet_type pkt, char data, int datalen);
245
246			void queue_command (packet_type handler, char data, int datalen);
247			bool handle_command ();
248	root	1.14	// resets movement state
249	root	1.5	void reset_state ();
250	root	1.1
251	root	1.4	bool handle_packet ();
252			int next_packet (); // returns length of packet or 0
253	root	1.1	void skip_packet (int len); // we have processed the packet, skip it
254
255			void flush ();
256			void write_outputbuffer ();
257			void send (void *buf_, int len);
258
259			void send_packet (const char *buf);
260			void send_packet (const char *buf, int len);
261	root	1.4	void send_packet_printf (const char *format, ...);
262	root	1.1	void send_packet (packet &sl);
263	root	1.7
264	root	1.10	// called when something under the player changes
265			void floorbox_update () { update_look = 1; }
266			// called when the player has been moved
267			void floorbox_reset () { look_position = 0; floorbox_update (); }
268
269	root	1.14	static client create (int fd, const char peername);
270	root	1.1	};
271
272			#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
273			( ((__type)>0) &&\
274			((__sockPtr)->has_readable_type) && \
275			((__sockPtr)->supported_readables & (1<<(__type))) )
276
277			/* Bitmask for the faces_sent[] array - what
278			* portion of the face have we sent?
279			*/
280			#define NS_FACESENT_FACE 0x1
281			#define NS_FACESENT_SMOOTH 0x2
282
283			/* Constants in the form EMI_ is for extended map infos.
284			* Even if the client select the additionnal infos it wants
285			* on the map, there may exist cases where this whole info
286			* is not given in one buch but in separate bunches. This
287			* is done performance reasons (imagine some info related to
288			* a visible object and another info related to a 4 square
289			* width and height area). At the begin of an extended info packet
290			* is a bit field. A bit is activated for each extended info
291			* present in the data
292			*/
293
294			/* Meanings:
295			* EMI_NOREDRAW Take extended infos into account but don't redraw,
296			* some additionnal datas will follow in a new packet
297			* EMI_SMOOTH Datas about smoothing
298			*/
299			#define EMI_NOREDRAW 0x01
300			#define EMI_SMOOTH 0x02
301
302			/* this last one says the bitfield continue un next byte
303			* There may be several on contiguous bytes. So there is 7
304			* actual bits used per byte, and the number of bytes
305			* is not fixed in protocol
306			*/
307			#define EMI_HASMOREBITS 0x80
308
309			#define FACE_TYPES 1
310			#define PNG_FACE_INDEX 0
311
312			#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
313			#define VERSION_SC 1027
314			#define VERSION_INFO "Crossfire+ Server"
315
316			typedef unordered_vector<client *> sockvec;
317
318			extern sockvec clients;
319			extern int nrofpixmaps; //TODO: hrmpf, should go
320
321			#endif
322