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>

// (possibly) max. number of objects "per page" in the ground container
#define NUM_LOOK_OBJECTS 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.
 */

enum Sock_Status { Ns_Add, Ns_Dead };

/* 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 outbut
 * data that the OS can't handle right away.
 */

struct Buffer
{
  char data[SOCKETBUFSIZE];
  int start;
  int len;
};

// a handler for a specific type of packet
enum {
  PF_PLAYER    = 0x01, // must have valid player
  PF_IMMEDIATE = 0x02, // TODO: hack, can be executed immediately
  PF_PLAYING   = 0x04, // 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 (tstamp stamp, const packet_type *handler, char *data, int datalen)
  : stamp (stamp), handler (handler), data (data), datalen (datalen)
  {
  }
};

/* 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_base
{
  enum Sock_Status status;
  int ACC (RW, fd);
  unsigned int inbuf_len;                 // number of bytes valid in inbuf
  struct Map lastmap;
  size_t faces_sent_len;        /* This is the number of elements allocated in faces_sent[] */
  uint8 *faces_sent;            /* This is a bitmap on sent face status */
  uint8 anims_sent[MAXANIMNUM];
  struct statsinfo stats;

  char *ACC (RW, host);                   /* Which host it is connected from (ip address) */
  uint8 ACC (RW, password_fails);         /* how many times the player has failed to give the right password */
  Buffer outputbuffer;          /* For undeliverable data */

  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 accept additionnal 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

  // 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];
  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 ();

  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;

  // those should probably be client methods
  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 ();

  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);
};

#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.4
Committed:	Sat Dec 16 03:08:26 2006 UTC (17 years, 5 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.3:	+48 -16 lines
Log Message:	- socket i/o is completely asynchronous now - some command sare handled immediately - others (most palying related commands) are queued for later (as of now synchronous) processing - specifying a max queue length (in seconds) is possible, but disabled - also add some syntax sugar for network code
#	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.1
29	root	1.4	// (possibly) max. number of objects "per page" in the ground container
30	root	1.1	#define NUM_LOOK_OBJECTS 50
31
32			struct MapCell
33			{
34			UUID player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
35			int count; /* This is really darkness in the map1 command */
36			uint16 faces[MAP_LAYERS];
37			uint16 smooth[MAP_LAYERS];
38			unsigned char stat_hp; // health of something in this space, or 0
39			unsigned char flags;
40			};
41
42			/* This basically defines the largest size an
43			* archetype may be - it is used for allocation of
44			* some structures, as well as determining how far
45			* we should look for the heads of big images.
46			*/
47			#define MAX_HEAD_OFFSET 8
48
49			#define MAX_CLIENT_X (MAP_CLIENT_X + MAX_HEAD_OFFSET)
50			#define MAX_CLIENT_Y (MAP_CLIENT_Y + MAX_HEAD_OFFSET)
51
52			struct Map
53			{
54			struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
55			};
56
57			/* True max is 16383 given current map compaction method */
58			# define MAXANIMNUM 2000
59
60			struct statsinfo
61			{
62			char range, title;
63			};
64
65			/* This contains basic information on the socket structure. status is its
66			* current state. we set up our on buffers for sending/receiving, so we can
67			* handle some higher level functions. fd is the actual file descriptor we
68			* are using.
69			*/
70
71			enum Sock_Status { Ns_Add, Ns_Dead };
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 outbut
80			* 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.4	// a handler for a specific type of packet
91			enum {
92			PF_PLAYER = 0x01, // must have valid player
93			PF_IMMEDIATE = 0x02, // TODO: hack, can be executed immediately
94			PF_PLAYING = 0x04, // 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 (tstamp stamp, const packet_type handler, char data, int datalen)
112			: stamp (stamp), handler (handler), data (data), datalen (datalen)
113			{
114			}
115			};
116
117	root	1.1	/* 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			struct Map lastmap;
127			size_t faces_sent_len; /* This is the number of elements allocated in faces_sent[] */
128			uint8 faces_sent; / This is a bitmap on sent face status */
129			uint8 anims_sent[MAXANIMNUM];
130			struct statsinfo stats;
131
132			char ACC (RW, host); / Which host it is connected from (ip address) */
133			uint8 ACC (RW, password_fails); /* how many times the player has failed to give the right password */
134			Buffer outputbuffer; /* For undeliverable data */
135
136			bool ACC (RW, facecache); /* If true, client is caching images */
137			bool ACC (RW, sent_scroll);
138			bool ACC (RW, sound); /* does the client want sound */
139			bool ACC (RW, exp64); /* Client wants 64 bit exp data, as well as skill data */
140			bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
141			bool ACC (RW, plugincmd); /* CF+ extend the protocol through a plug-in */
142			bool ACC (RW, mapinfocmd); /* CF+ return map info and send map change info */
143			bool ACC (RW, extcmd); /* CF+ call into extensions/plugins */
144			bool ACC (RW, extmap); /* CF+ extend map comamnd with extra data */
145			bool ACC (RW, buggy_mapscroll); /* CF+ client crashes on large mapscrolls */
146			bool ACC (RW, darkness); /* True if client wants darkness information */
147			bool ACC (RW, image2); /* Client wants image2/face2 commands */
148			bool ACC (RW, update_look); /* If true, we need to send the look window */
149			bool ACC (RW, has_readable_type); /* If true client accept additional text information */
150			/* used to arrange text in books, scrolls, or scripted dialogs */
151			bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
152			bool ACC (RW, ext_mapinfos); /* If true client accept additionnal info on maps */
153			/* Below are flags for extedend infos to pass to client
154			* with S->C mapextended command */
155			bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
156
157			uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
158			uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
159			enum MapMode mapmode; /* Type of map commands the client wants. */
160			uint16 ACC (RW, look_position); /* start of drawing of look window */
161			uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
162			uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
163			uint8 ACC (RW, faceset); /* Set the client is using, default 0 */
164
165			maptile *ACC (RW, current_map); // CF+ last/current player map
166			int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
167			char ACC (RW, version)[64]; // CF+ client name/version
168
169	root	1.4	// if we get an incomplete packet, this is used to hold the data.
170			// we add 2 byte for the header, one for the trailing 0 byte
171			uint8 inbuf[MAXSOCKBUF + 2 + 1];
172	root	1.1	player *ACC (RO, pl);//TODO should not be here, preferably
173
174			int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
175
176	root	1.4	client (int fd, const char *from_ip);
177			~client ();
178			void destroy ();
179
180			iw cmd_ev; void cmd_cb (iw &w);
181	root	1.1	iow socket_ev; void socket_cb (iow &w, int got);
182
183	root	1.4	std::deque< command, slice_allocator<command> > cmd_queue;
184
185			// those should probably be client methods
186			bool may_execute (const packet_type *pkt) const;
187			void execute (const packet_type pkt, char data, int datalen);
188
189			void queue_command (packet_type handler, char data, int datalen);
190			bool handle_command ();
191	root	1.1
192	root	1.4	bool handle_packet ();
193			int next_packet (); // returns length of packet or 0
194	root	1.1	void skip_packet (int len); // we have processed the packet, skip it
195
196			void flush ();
197			void write_outputbuffer ();
198			void send (void *buf_, int len);
199
200			void send_packet (const char *buf);
201			void send_packet (const char *buf, int len);
202	root	1.4	void send_packet_printf (const char *format, ...);
203	root	1.1	void send_packet (packet &sl);
204			};
205
206			#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
207			( ((__type)>0) &&\
208			((__sockPtr)->has_readable_type) && \
209			((__sockPtr)->supported_readables & (1<<(__type))) )
210
211			/* Bitmask for the faces_sent[] array - what
212			* portion of the face have we sent?
213			*/
214			#define NS_FACESENT_FACE 0x1
215			#define NS_FACESENT_SMOOTH 0x2
216
217			/* Constants in the form EMI_ is for extended map infos.
218			* Even if the client select the additionnal infos it wants
219			* on the map, there may exist cases where this whole info
220			* is not given in one buch but in separate bunches. This
221			* is done performance reasons (imagine some info related to
222			* a visible object and another info related to a 4 square
223			* width and height area). At the begin of an extended info packet
224			* is a bit field. A bit is activated for each extended info
225			* present in the data
226			*/
227
228			/* Meanings:
229			* EMI_NOREDRAW Take extended infos into account but don't redraw,
230			* some additionnal datas will follow in a new packet
231			* EMI_SMOOTH Datas about smoothing
232			*/
233			#define EMI_NOREDRAW 0x01
234			#define EMI_SMOOTH 0x02
235
236			/* this last one says the bitfield continue un next byte
237			* There may be several on contiguous bytes. So there is 7
238			* actual bits used per byte, and the number of bytes
239			* is not fixed in protocol
240			*/
241			#define EMI_HASMOREBITS 0x80
242
243			#define FACE_TYPES 1
244			#define PNG_FACE_INDEX 0
245
246			#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
247			#define VERSION_SC 1027
248			#define VERSION_INFO "Crossfire+ Server"
249
250			typedef unordered_vector<client *> sockvec;
251
252			extern sockvec clients;
253			extern int nrofpixmaps; //TODO: hrmpf, should go
254
255			#endif
256