server/include/client.h

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 * 
 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Deliantra 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 3 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, see <http://www.gnu.org/licenses/>.
 * 
 * The authors can be reached via e-mail to <support@deliantra.net>
 */

#ifndef CLIENT_H
#define CLIENT_H

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

#if HAVE_TCP_INFO
# include <netinet/tcp.h>
#else
  struct tcp_info {
    // dummy
    int tcpi_state;
    int tcpi_ca_state;
    int tcpi_retransmits;
    int tcpi_probes;
    int tcpi_backoff;
    int tcpi_options;
    int tcpi_snd_wscale;
    int tcpi_rcv_wscale;
    int tcpi_rto;
    int tcpi_ato;
    int tcpi_snd_mss;
    int tcpi_rcv_mss;
    int tcpi_unacked;
    int tcpi_sacked;
    int tcpi_lost;
    int tcpi_retrans;
    int tcpi_fackets;
    int tcpi_last_data_sent;
    int tcpi_last_ack_sent;
    int tcpi_last_data_recv;
    int tcpi_last_ack_recv;
    int tcpi_pmtu;
    int tcpi_rcv_ssthresh;
    int tcpi_rtt;
    int tcpi_rttvar;
    int tcpi_snd_ssthresh;
    int tcpi_snd_cwnd;
    int tcpi_advmss;
    int tcpi_reordering;
  };
#endif

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

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

#define MAX_CLIENT_X MAP_CLIENT_X
#define MAX_CLIENT_Y MAP_CLIENT_Y

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

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

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 { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };

// 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_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
  PF_COMMAND0 = 0x04, // command starts at offset 0
  PF_COMMAND6 = 0x08, // command starts at offset 6
};

// face type.s bit 0 means "has meta info prepended"
enum {
  FT_FACE  = 0 * 2 + 0, // faces (images)
  FT_MUSIC = 1 * 2 + 1, // background music
  FT_SOUND = 2 * 2 + 1, // effects
  FT_RSRC  = 3 * 2 + 0, // generic data files
  FT_NUM,
};

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

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

/* 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
  statsinfo stats;
  object_vector_index ACC (RO, active);
  player_ptr ACC (RO, pl);

  char *ACC (RW, host);                   /* Which host it is connected from (ip address) */
  uint8 ACC (RW, state);                  /* Input state of the player (name, password, etc */

  sint8 ACC (RW, last_level);             /* Last level we sent to client */
  uint16 ACC (RW, last_flags);            /* fire/run on flags for last tick */
  float ACC (RW, last_weapon_sp);         /* if diff than weapon_sp, update client */
  sint32 ACC (RW, last_weight);           /* Last weight as sent to client; -1 means do not send weight */
  sint32 ACC (RW, last_weight_limit);     /* Last weight limit transmitted to client */
  uint32 ACC (RW, last_path_attuned);     /* Last spell attunment sent to client */
  uint32 ACC (RW, last_path_repelled);    /* Last spell repelled sent to client */
  uint32 ACC (RW, last_path_denied);      /* Last spell denied sent to client */
  living ACC (RO, last_stats);            /* Last stats as sent to client */
  float ACC (RW, last_speed);             /* Last speed as sent to client */
  sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
  sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */

  bool ACC (RW, force_face0);             // client workaround for buggy checksum calculation in gcfclient
  bool ACC (RW, force_bad_checksum);      // client workaround for buggy checksum calculation in gcfclient
  bool ACC (RW, force_image_newmap);      // client workaround for client not redrawing map on image upload
  bool ACC (RW, enable_bg_scrub);         // client workaround, gcfclient becomes unusable if you send it images

  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);               // extend the protocol through a plug-in */
  bool ACC (RW, mapinfocmd);              // return map info and send map change info
  uint8_t ACC (RW, extcmd);                  // call into extensions/plugins
  bool ACC (RW, extmap);                  // extend map comamnd with extra data
  bool ACC (RW, buggy_mapscroll);         // client crashes on large mapscrolls
  bool ACC (RW, darkness);                /* True if client wants darkness information */
  bool ACC (RW, image2);                  /* Client wants image2/face2 commands */
  uint8_t ACC (RW, fxix);                 // client implements fx and ix (face|image extended) 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 */
  bool ACC (RW, smoothing);               // trt-style smoothing
  bool ACC (RW, can_msg);                 // trt-style text messages

  bool ACC (RW, force_newmap);            // force a newmap before next map update
  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 */
  uint16 ACC (RW, look_position);         /* start of drawing of look window */
  uint16 ACC (RW, mss);                   // likely tcp maximum segment size
  uint8 ACC (RW, mapmode);                /* Type of map commands the client wants. */
  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 */

  maptile_ptr ACC (RW, current_map);      // CF+ last/current player map
  region_ptr ACC (RW, current_region);    // CF+ last/current player region
  int ACC (RW, current_x), ACC (RW, current_y);     // CF+ last/current map position
  shstr ACC (RW, version);                // CF+ client name/version
  uint8 ACC (RW, faceset);                // CF+ selected faceset

  tstamp ACC (RW, last_send);             // last data send on socket.

  int ACC (RW, rate_avail);               // current rate balance
  int ACC (RW, max_rate);                 // max. # of bytes to send per tick
  faceidx ACC (RW, scrub_idx);            // which face to send next
  int ACC (RW, bg_scrub);                 // how many ticks till the next background face send

  struct tcp_info tcpi;
  tstamp next_rate_adjust;

  unordered_vector<char *> mapinfo_queue;
  void mapinfo_queue_clear ();
  void mapinfo_queue_run ();
  bool mapinfo_try (char *buf);

  struct ixsend {
    int16_t pri; // unused
    faceidx idx;
    uint32_t ofs;  // if != 0, need to send remaining bytes of partial_face
  };
  std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix

  std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
  MTH void flush_fx (); // send fx if required

  void do_destroy ();
  void gather_callbacks (AV *&callbacks, event_type event) const;

  iow socket_ev; void socket_cb (iow &w, int revents);

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

  // large structures at the end please
  struct Map lastmap;
  std::bitset<MAXANIMNUM> anims_sent;
  std::bitset<MAX_FACES> faces_sent;
  std::bitset<FT_NUM> fx_want;

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

  enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
  struct msg_buf
  {
    tick_t expire;
    int len;
    int count;
    char msg[MSG_BUF_SIZE];
  } msgbuf[MSG_BUF_COUNT];

  MTH bool msg_suppressed (const char *msg);

  /* The following is the setup for a ring buffer for storing output
   * data that the OS can't handle right away.
   * TODO: this member is enourmously large - optimise?
   */
  struct
  {
    char data[SOCKETBUFSIZE];
    int start;
    int len;
  } outputbuffer;

  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);
  MTH bool handle_command ();
  // resets movement state
  MTH void reset_state ();
  // resets variable data used to send stat diffs
  MTH void reset_stats ();

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

  MTH void flush ();
  MTH void write_outputbuffer ();
  MTH int outputbuffer_len () const { return outputbuffer.len; }
  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);

  void send_drawinfo (const char *msg, int flags = NDI_BLACK);

  MTH void send_face (faceidx facenum, int pri = 0);
  MTH void send_image (faceidx facenum);
  MTH void send_faces (object *ob);
  MTH void send_animation (short anim_num);
  void send_msg (int color, const char *type, const char *msg);

  MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
  // called when something under the player changes
  MTH void floorbox_update () { update_look = 1; }
  // called when the player has been moved
  MTH void floorbox_reset  () { look_position = 0; floorbox_update (); }

  MTH void tick (); // called every server tick to do housekeeping etc.

  MTH static client *create (int fd, const char *peername);
  MTH static void clock ();
  MTH static void flush_sockets ();

protected:
  client (int fd, const char *from_ip);
  ~client ();
};

#if FOR_PERL
  ACC (RW, tcpi.tcpi_state);
  ACC (RW, tcpi.tcpi_ca_state);
  ACC (RW, tcpi.tcpi_retransmits);
  ACC (RW, tcpi.tcpi_probes);
  ACC (RW, tcpi.tcpi_backoff);
  ACC (RW, tcpi.tcpi_options);
  ACC (RO, tcpi.tcpi_snd_wscale);
  ACC (RO, tcpi.tcpi_rcv_wscale);
  ACC (RW, tcpi.tcpi_rto);
  ACC (RW, tcpi.tcpi_ato);
  ACC (RW, tcpi.tcpi_snd_mss);
  ACC (RW, tcpi.tcpi_rcv_mss);
  ACC (RW, tcpi.tcpi_unacked);
  ACC (RW, tcpi.tcpi_sacked);
  ACC (RW, tcpi.tcpi_lost);
  ACC (RW, tcpi.tcpi_retrans);
  ACC (RW, tcpi.tcpi_fackets);
  ACC (RW, tcpi.tcpi_last_data_sent);
  ACC (RW, tcpi.tcpi_last_ack_sent);
  ACC (RW, tcpi.tcpi_last_data_recv);
  ACC (RW, tcpi.tcpi_last_ack_recv);
  ACC (RW, tcpi.tcpi_pmtu);
  ACC (RW, tcpi.tcpi_rcv_ssthresh);
  ACC (RW, tcpi.tcpi_rtt);
  ACC (RW, tcpi.tcpi_rttvar);
  ACC (RW, tcpi.tcpi_snd_ssthresh);
  ACC (RW, tcpi.tcpi_snd_cwnd);
  ACC (RW, tcpi.tcpi_advmss);
  ACC (RW, tcpi.tcpi_reordering);
#endif

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

/* 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 1026
//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
#define VERSION_INFO "Deliantra Server"

typedef object_vector<client, &client::active> sockvec;

extern sockvec clients;

#define for_all_clients(var)                    \
  for (int _i = 0; _i < clients.size (); ++_i)  \
    statementvar (client *, var, clients [_i])

// returns true when the message needs special (read: perl) treatment
static inline bool
msg_is_special (const char *msg, bool nl_special = true)
{   
  return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
}

#endif

Revision:	1.82
Committed:	Tue Dec 23 22:03:06 2008 UTC (15 years, 5 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.81:	+11 -10 lines
Log Message:	improve los, fix bugs
#	User	Rev	Content
1	root	1.1	/*
2	root	1.69	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	pippijn	1.26	*
4	root	1.77	* Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	root	1.51	* Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6			* Copyright (©) 1992,2007 Frank Tore Johansen
7	pippijn	1.26	*
8	root	1.69	* Deliantra is free software: you can redistribute it and/or modify
9	root	1.59	* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation, either version 3 of the License, or
11			* (at your option) any later version.
12	pippijn	1.26	*
13	root	1.59	* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17	pippijn	1.26	*
18	root	1.59	* You should have received a copy of the GNU General Public License
19			* along with this program. If not, see <http://www.gnu.org/licenses/>.
20	root	1.51	*
21	root	1.69	* The authors can be reached via e-mail to <support@deliantra.net>
22	pippijn	1.26	*/
23	root	1.1
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.65	#if HAVE_TCP_INFO
32			# include <netinet/tcp.h>
33			#else
34	root	1.74	struct tcp_info {
35	root	1.65	// dummy
36	root	1.75	int tcpi_state;
37			int tcpi_ca_state;
38			int tcpi_retransmits;
39			int tcpi_probes;
40			int tcpi_backoff;
41			int tcpi_options;
42			int tcpi_snd_wscale;
43			int tcpi_rcv_wscale;
44			int tcpi_rto;
45			int tcpi_ato;
46			int tcpi_snd_mss;
47			int tcpi_rcv_mss;
48			int tcpi_unacked;
49			int tcpi_sacked;
50			int tcpi_lost;
51			int tcpi_retrans;
52			int tcpi_fackets;
53			int tcpi_last_data_sent;
54			int tcpi_last_ack_sent;
55			int tcpi_last_data_recv;
56			int tcpi_last_ack_recv;
57			int tcpi_pmtu;
58			int tcpi_rcv_ssthresh;
59			int tcpi_rtt;
60			int tcpi_rttvar;
61			int tcpi_snd_ssthresh;
62			int tcpi_snd_cwnd;
63			int tcpi_advmss;
64			int tcpi_reordering;
65	root	1.65	};
66			#endif
67
68	root	1.4	// (possibly) max. number of objects "per page" in the ground container
69	root	1.11	#define FLOORBOX_PAGESIZE 50
70	root	1.1
71			struct MapCell
72			{
73	root	1.79	tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
74	root	1.37	int count; /* This is really darkness in the map1 command */
75	root	1.32	faceidx faces[MAP_LAYERS];
76	root	1.36	unsigned char stat_hp; // health of something in this space, or 0
77	root	1.1	unsigned char flags;
78	root	1.37	uint8_t smooth[MAP_LAYERS];
79	root	1.1	};
80
81	root	1.33	#define MAX_CLIENT_X MAP_CLIENT_X
82			#define MAX_CLIENT_Y MAP_CLIENT_Y
83	root	1.1
84			struct Map
85			{
86			struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
87			};
88
89			/* True max is 16383 given current map compaction method */
90	root	1.33	#define MAXANIMNUM 10000
91	root	1.1
92			struct statsinfo
93			{
94			char range, title;
95			};
96
97			/* This contains basic information on the socket structure. status is its
98			* current state. we set up our on buffers for sending/receiving, so we can
99			* handle some higher level functions. fd is the actual file descriptor we
100			* are using.
101			*/
102
103			/* Only one map mode can actually be used, so lets make it a switch
104			* instead of having a bunch of different fields that needed to
105			* get toggled.
106			*/
107	root	1.42	enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
108	root	1.1
109	root	1.15	// states the socket can be in
110			enum {
111			ST_DEAD, // socket is dead
112			ST_SETUP, // initial handshake / setup / login
113			ST_PLAYING, // logged in an playing
114			ST_CUSTOM, // waiting for custom reply
115
116			ST_GET_PARTY_PASSWORD,
117			};
118
119	root	1.4	// a handler for a specific type of packet
120			enum {
121	root	1.28	PF_PLAYER = 0x01, // must have valid player / will by synchronised
122			PF_PLAYING = 0x02, // must be in playing state
123			PF_COMMAND0 = 0x04, // command starts at offset 0
124			PF_COMMAND6 = 0x08, // command starts at offset 6
125	root	1.4	};
126
127	root	1.63	// face type.s bit 0 means "has meta info prepended"
128			enum {
129			FT_FACE = 0 * 2 + 0, // faces (images)
130			FT_MUSIC = 1 * 2 + 1, // background music
131			FT_SOUND = 2 * 2 + 1, // effects
132			FT_RSRC = 3 * 2 + 0, // generic data files
133			FT_NUM,
134			};
135
136	root	1.4	struct packet_type
137			{
138			const char *name;
139			void *cb;
140			int flags;
141			};
142
143			struct command
144			{
145			tstamp stamp;
146			const packet_type *handler;
147			char *data;
148			int datalen;
149			};
150
151	root	1.1	/* how many times we are allowed to give the wrong password before being kicked. */
152			#define MAX_PASSWORD_FAILURES 5
153
154	root	1.21	INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
155			struct client : zero_initialised, attachable
156	root	1.1	{
157			int ACC (RW, fd);
158	root	1.10	unsigned int inbuf_len; // number of bytes valid in inbuf
159	root	1.20	statsinfo stats;
160	root	1.54	object_vector_index ACC (RO, active);
161	root	1.53	player_ptr ACC (RO, pl);
162	root	1.12
163	root	1.10	char ACC (RW, host); / Which host it is connected from (ip address) */
164	root	1.15	uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
165	root	1.25
166			sint8 ACC (RW, last_level); /* Last level we sent to client */
167			uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
168			float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
169	root	1.76	sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
170	root	1.25	sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
171			uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
172			uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
173			uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
174			living ACC (RO, last_stats); /* Last stats as sent to client */
175			float ACC (RW, last_speed); /* Last speed as sent to client */
176			sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
177			sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
178	root	1.10
179	root	1.42	bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
180			bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
181			bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
182			bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
183
184	root	1.20	bool ACC (RW, afk); /* player is afk */
185	root	1.10	bool ACC (RW, facecache); /* If true, client is caching images */
186			bool ACC (RW, sent_scroll);
187			bool ACC (RW, sound); /* does the client want sound */
188			bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
189	root	1.40	bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
190			bool ACC (RW, mapinfocmd); // return map info and send map change info
191	root	1.62	uint8_t ACC (RW, extcmd); // call into extensions/plugins
192	root	1.40	bool ACC (RW, extmap); // extend map comamnd with extra data
193			bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
194	root	1.10	bool ACC (RW, darkness); /* True if client wants darkness information */
195			bool ACC (RW, image2); /* Client wants image2/face2 commands */
196	root	1.57	uint8_t ACC (RW, fxix); // client implements fx and ix (face\|image extended) commands
197	root	1.10	bool ACC (RW, update_look); /* If true, we need to send the look window */
198			bool ACC (RW, has_readable_type); /* If true client accept additional text information */
199			/* used to arrange text in books, scrolls, or scripted dialogs */
200			bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
201			bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
202			/* Below are flags for extedend infos to pass to client
203			* with S->C mapextended command */
204			bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
205	root	1.48	bool ACC (RW, smoothing); // trt-style smoothing
206			bool ACC (RW, can_msg); // trt-style text messages
207	root	1.1
208	root	1.40	bool ACC (RW, force_newmap); // force a newmap before next map update
209	root	1.1	uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
210			uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
211			uint16 ACC (RW, look_position); /* start of drawing of look window */
212	root	1.43	uint16 ACC (RW, mss); // likely tcp maximum segment size
213	root	1.42	uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
214	root	1.1	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
217	root	1.80	maptile_ptr ACC (RW, current_map); // CF+ last/current player map
218			region_ptr ACC (RW, current_region); // CF+ last/current player region
219	root	1.1	int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
220	root	1.49	shstr ACC (RW, version); // CF+ client name/version
221	root	1.32	uint8 ACC (RW, faceset); // CF+ selected faceset
222	root	1.1
223	root	1.53	tstamp ACC (RW, last_send); // last data send on socket.
224	root	1.1
225	root	1.44	int ACC (RW, rate_avail); // current rate balance
226	root	1.38	int ACC (RW, max_rate); // max. # of bytes to send per tick
227	root	1.39	faceidx ACC (RW, scrub_idx); // which face to send next
228			int ACC (RW, bg_scrub); // how many ticks till the next background face send
229	root	1.45
230	root	1.65	struct tcp_info tcpi;
231			tstamp next_rate_adjust;
232	root	1.67
233			unordered_vector<char *> mapinfo_queue;
234			void mapinfo_queue_clear ();
235			void mapinfo_queue_run ();
236			bool mapinfo_try (char *buf);
237	root	1.65
238	root	1.58	struct ixsend {
239			int16_t pri; // unused
240			faceidx idx;
241			uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
242			};
243			std::vector<ixsend, slice_allocator<ixsend> > ixface; // which faces to send to the client using ix
244	root	1.45
245	root	1.57	std::vector<faceidx, slice_allocator<faceidx> > fxface; // which faces to send using fx
246	root	1.45	MTH void flush_fx (); // send fx if required
247	root	1.1
248	root	1.21	void do_destroy ();
249			void gather_callbacks (AV *&callbacks, event_type event) const;
250	root	1.4
251	root	1.70	iow socket_ev; void socket_cb (iow &w, int revents);
252	root	1.1
253	root	1.4	std::deque< command, slice_allocator<command> > cmd_queue;
254
255	root	1.14	// large structures at the end please
256			struct Map lastmap;
257			std::bitset<MAXANIMNUM> anims_sent;
258	root	1.36	std::bitset<MAX_FACES> faces_sent;
259	root	1.63	std::bitset<FT_NUM> fx_want;
260	root	1.36
261	root	1.14	// if we get an incomplete packet, this is used to hold the data.
262			// we add 2 byte for the header, one for the trailing 0 byte
263			uint8 inbuf[MAXSOCKBUF + 2 + 1];
264
265	root	1.49	enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
266			struct msg_buf
267			{
268			tick_t expire;
269			int len;
270			int count;
271			char msg[MSG_BUF_SIZE];
272			} msgbuf[MSG_BUF_COUNT];
273
274			MTH bool msg_suppressed (const char *msg);
275
276	root	1.82	/* The following is the setup for a ring buffer for storing output
277			* data that the OS can't handle right away.
278			* TODO: this member is enourmously large - optimise?
279			*/
280			struct
281			{
282			char data[SOCKETBUFSIZE];
283			int start;
284			int len;
285			} outputbuffer;
286
287	root	1.4	bool may_execute (const packet_type *pkt) const;
288			void execute (const packet_type pkt, char data, int datalen);
289
290			void queue_command (packet_type handler, char data, int datalen);
291	root	1.22	MTH bool handle_command ();
292	root	1.14	// resets movement state
293	root	1.22	MTH void reset_state ();
294	root	1.25	// resets variable data used to send stat diffs
295			MTH void reset_stats ();
296	root	1.1
297	root	1.22	MTH bool handle_packet ();
298	root	1.4	int next_packet (); // returns length of packet or 0
299	root	1.1	void skip_packet (int len); // we have processed the packet, skip it
300
301	root	1.22	MTH void flush ();
302			MTH void write_outputbuffer ();
303	root	1.38	MTH int outputbuffer_len () const { return outputbuffer.len; }
304	root	1.1	void send (void *buf_, int len);
305
306			void send_packet (const char *buf);
307			void send_packet (const char *buf, int len);
308	root	1.4	void send_packet_printf (const char *format, ...);
309	root	1.1	void send_packet (packet &sl);
310	root	1.7
311	root	1.35	void send_drawinfo (const char *msg, int flags = NDI_BLACK);
312	root	1.60
313	root	1.63	MTH void send_face (faceidx facenum, int pri = 0);
314	root	1.38	MTH void send_image (faceidx facenum);
315	root	1.35	MTH void send_faces (object *ob);
316			MTH void send_animation (short anim_num);
317	root	1.55	void send_msg (int color, const char type, const char msg);
318	root	1.35
319	root	1.64	MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
320	root	1.10	// called when something under the player changes
321	root	1.22	MTH void floorbox_update () { update_look = 1; }
322	root	1.10	// called when the player has been moved
323	root	1.22	MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
324
325	root	1.39	MTH void tick (); // called every server tick to do housekeeping etc.
326
327	root	1.22	MTH static client create (int fd, const char peername);
328	root	1.66	MTH static void clock ();
329			MTH static void flush_sockets ();
330	root	1.10
331	root	1.22	protected:
332			client (int fd, const char *from_ip);
333			~client ();
334	root	1.1	};
335
336	root	1.67	#if FOR_PERL
337			ACC (RW, tcpi.tcpi_state);
338			ACC (RW, tcpi.tcpi_ca_state);
339			ACC (RW, tcpi.tcpi_retransmits);
340			ACC (RW, tcpi.tcpi_probes);
341			ACC (RW, tcpi.tcpi_backoff);
342			ACC (RW, tcpi.tcpi_options);
343			ACC (RO, tcpi.tcpi_snd_wscale);
344			ACC (RO, tcpi.tcpi_rcv_wscale);
345			ACC (RW, tcpi.tcpi_rto);
346			ACC (RW, tcpi.tcpi_ato);
347			ACC (RW, tcpi.tcpi_snd_mss);
348			ACC (RW, tcpi.tcpi_rcv_mss);
349			ACC (RW, tcpi.tcpi_unacked);
350			ACC (RW, tcpi.tcpi_sacked);
351			ACC (RW, tcpi.tcpi_lost);
352			ACC (RW, tcpi.tcpi_retrans);
353			ACC (RW, tcpi.tcpi_fackets);
354			ACC (RW, tcpi.tcpi_last_data_sent);
355			ACC (RW, tcpi.tcpi_last_ack_sent);
356			ACC (RW, tcpi.tcpi_last_data_recv);
357			ACC (RW, tcpi.tcpi_last_ack_recv);
358			ACC (RW, tcpi.tcpi_pmtu);
359			ACC (RW, tcpi.tcpi_rcv_ssthresh);
360			ACC (RW, tcpi.tcpi_rtt);
361			ACC (RW, tcpi.tcpi_rttvar);
362			ACC (RW, tcpi.tcpi_snd_ssthresh);
363			ACC (RW, tcpi.tcpi_snd_cwnd);
364			ACC (RW, tcpi.tcpi_advmss);
365			ACC (RW, tcpi.tcpi_reordering);
366			#endif
367
368	root	1.1	#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
369			( ((__type)>0) &&\
370			((__sockPtr)->has_readable_type) && \
371			((__sockPtr)->supported_readables & (1<<(__type))) )
372
373			/* Constants in the form EMI_ is for extended map infos.
374			* Even if the client select the additionnal infos it wants
375			* on the map, there may exist cases where this whole info
376			* is not given in one buch but in separate bunches. This
377			* is done performance reasons (imagine some info related to
378			* a visible object and another info related to a 4 square
379			* width and height area). At the begin of an extended info packet
380			* is a bit field. A bit is activated for each extended info
381			* present in the data
382			*/
383
384			/* Meanings:
385			* EMI_NOREDRAW Take extended infos into account but don't redraw,
386			* some additionnal datas will follow in a new packet
387			* EMI_SMOOTH Datas about smoothing
388			*/
389			#define EMI_NOREDRAW 0x01
390			#define EMI_SMOOTH 0x02
391
392			/* this last one says the bitfield continue un next byte
393			* There may be several on contiguous bytes. So there is 7
394			* actual bits used per byte, and the number of bytes
395			* is not fixed in protocol
396			*/
397			#define EMI_HASMOREBITS 0x80
398
399			#define FACE_TYPES 1
400			#define PNG_FACE_INDEX 0
401
402			#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
403	root	1.31	#define VERSION_SC 1026
404			//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
405	root	1.69	#define VERSION_INFO "Deliantra Server"
406	root	1.1
407	root	1.24	typedef object_vector<client, &client::active> sockvec;
408	root	1.1
409			extern sockvec clients;
410	root	1.24
411			#define for_all_clients(var) \
412			for (int _i = 0; _i < clients.size (); ++_i) \
413	root	1.52	statementvar (client *, var, clients [_i])
414	root	1.24
415	root	1.78	// returns true when the message needs special (read: perl) treatment
416			static inline bool
417			msg_is_special (const char *msg, bool nl_special = true)
418			{
419	root	1.81	return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
420	root	1.78	}
421
422	root	1.1	#endif
423