server/socket/lowlevel.C

/*
 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
 * 
 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Crossfire TRT 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 Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * The authors can be reached via e-mail to <crossfire@schmorp.de>
 */

using namespace std;

#include <global.h>
#include <sproto.h>
#include <cstdarg>

#if HAVE_TCP_INFO
# include <sys/types.h>
# include <sys/socket.h>
# include <netinet/in.h>
# include <netinet/tcp.h>
#endif

// disconnect a socket after this many seconds without an ack
#define SOCKET_TIMEOUT 8.

// force a packet when idle for more than this many seconds,
// forcing an ack regularly.
#define IDLE_PING 2.

void
client::flush ()
{
  if (destroyed ())
    return;

#if HAVE_TCP_INFO
  // check about once per second, spread evenly over all clients
  // do this only when player is active
  if (!((pticks + fd) & 7) && pl && pl->active)
    {
      // check time of last ack, and, if too old, kill connection
      struct tcp_info tcpi;
      socklen_t len = sizeof (tcpi);

      if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi))
        {
          if (tcpi.tcpi_snd_mss)
            mss = tcpi.tcpi_snd_mss;

          rtt    = tcpi.tcpi_rtt;
          rttvar = tcpi.tcpi_rttvar;

          if (tcpi.tcpi_last_ack_recv > int (SOCKET_TIMEOUT * 1000))
            {
              send_msg (NDI_RED, "connection-timeout", "safety disconnect due to tcp/ip timeout (no packets received)");
              write_outputbuffer ();

              LOG (llevDebug, "connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd,
                   (unsigned)tcpi.tcpi_last_ack_recv, (unsigned)tcpi.tcpi_last_data_sent, (unsigned)tcpi.tcpi_unacked);
              destroy ();
            }
        }
    }
#endif

  /**
   * Writes data to socket.
   *
   * When the socket is clear to write, and we have backlogged data, this
   * is called to write it out.
   */

  // write a nop to the socket at least every IDLE_NOP seconds.
  if (!outputbuffer.len)
    {
      if (last_send + IDLE_PING <= NOW && pl && pl->active)
        {
          // this is a bit ugly, but map1/map1a seem to be the only
          // nop'able commands and they are quite small.
          packet sl (mapmode == Map1Cmd ? "map1" : "map1a");
          send_packet (sl);
        }
      else
        return;
    }

  if (socket_ev.poll () & PE_W)
    return;

  last_send = NOW;
  write_outputbuffer ();
}

void
client::write_outputbuffer ()
{
  while (outputbuffer.len)
    {
      int res = write (fd, outputbuffer.data + outputbuffer.start,
                       min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));

      if (res > 0)
        {
          outputbuffer.start += res;
          /* wrap back to start of buffer */
          if (outputbuffer.start == SOCKETBUFSIZE)
            outputbuffer.start = 0;

          outputbuffer.len -= res;
        }
      else if (res == 0)
        {
          LOG (llevError, "socket write failed, connection closed.\n");
          destroy ();
          return;
        }
      else if (errno == EINTR)
        {
          // just retry
        }
      else if (errno == EAGAIN)
        {
          // delay till ready
          socket_ev.poll (socket_ev.poll () | PE_W);
          socket_ev.start ();
          return;
        }
      else
        {
          LOG (llevError, "socket write failed: %s\n", strerror (errno));
          destroy ();
          return;
        }
    }

  socket_ev.poll (socket_ev.poll () & ~PE_W);
}

/******************************************************************************
 *
 * Start of read routines.
 *
 ******************************************************************************/

int
client::next_packet ()
{
  if (inbuf_len >= 2)
    {
      int pkt_len = (inbuf [0] << 8) | inbuf [1];

      if (inbuf_len >= 2 + pkt_len)
        return 2 + pkt_len;

      if (inbuf_len == sizeof (inbuf))
        {
          send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED);
          destroy ();
          return -1;
        }
    }

  return 0;
}

void
client::skip_packet (int len)
{
  inbuf_len -= len;
  memmove (inbuf, inbuf + len, inbuf_len);
}

/*****************************************************************************
 * Start of command dispatch area.
 * The commands here are protocol commands. 
 ****************************************************************************/

// SocketCommand, PlayingCommand, should not exist with those ugly casts
#define SC(cb) (void *)static_cast<void (*)(char *, int, client *)>(cb),
#define PC(cb) (void *)static_cast<void (*)(char *, int, player *)>(cb), PF_PLAYER |

/**
 * Dispatch table for the server.
 */
static struct packet_type packets[] = {
  {"ncom",        PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 },
  {"command",     PC(PlayerCmd)    PF_PLAYING | PF_COMMAND0 },

  {"examine",     PC(ExamineCmd)   PF_PLAYING },
  {"ex",          PC(ExCmd)        PF_PLAYING },
  {"apply",       PC(ApplyCmd)     PF_PLAYING },
  {"lookat",      PC(LookAt)       PF_PLAYING },
  {"lock",        PC(LockItem)     PF_PLAYING },
  {"mark",        PC(MarkItem)     PF_PLAYING },
  {"move",        PC(MoveCmd)      PF_PLAYING },
  {"ext",         PC(ExtCmd)       0 }, // CF+
  {"mapredraw",   PC(MapRedrawCmd) 0 },
  {"mapinfo",     PC(MapInfoCmd)   0 }, // CF+

  {"reply",       SC(ReplyCmd)     0 },
  {"exti",        SC(ExtiCmd)      0 }, // CF+
  {"addme",       SC(AddMeCmd)     0 },
  {"askface",     SC(AskFaceCmd)   0 },
  {"requestinfo", SC(RequestInfo)  0 },
  {"setfacemode", SC(SetFaceMode)  0 },
  {"setsound",    SC(SetSound)     0 },
  {"setup",       SC(SetUp)        0 },
  {"version",     SC(VersionCmd)   0 },
  {"toggleextendedinfos", SC(ToggleExtendedInfos) 0 }, /*Added: tchize */
  {"toggleextendedtext",  SC(ToggleExtendedText)  0 },   /*Added: tchize */
  {"asksmooth",   SC(AskSmooth)    0 },     /*Added: tchize (smoothing technologies) */
};

bool
client::may_execute (const packet_type *pkt) const
{
  return (!(pkt->flags & PF_PLAYER)  || pl)
      && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
}

// HACK: some commands currently should be executed 
// even when the player is frozen. this hack detects
// those commands. it should be folded into may_execute,
// but kept seperate to emphasise the hack aspect, i.e.
// do it better, then remove.
static bool
always_immediate (const client *ns, const packet_type *pkt, const char *data, int len)
{
  if (!(pkt->flags & (PF_COMMAND0 | PF_COMMAND6)))
    return false;

  if (!ns->pl || !ns->pl->ob || !ns->pl->ob->map)
    return false;

  if (pkt->flags & PF_COMMAND6)
    {
      data += 6;
      len  -= 6;
    }

  if (len > 4 && !strncmp (data, "say " , 4))
    return true;
  if (len > 5 && !strncmp (data, "chat ", 5))
    return true;

  return false;
}

void
client::execute (const packet_type *pkt, char *data, int datalen)
{
  if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
    {
      //TODO: only one format
      if (pkt->flags & PF_PLAYER)
        ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
      else
        ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
    }
  else
    send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED, pkt->name);
}

bool
client::handle_packet ()
{
  int pkt_len = next_packet ();

  if (!pkt_len)
    return false;
  else if (pkt_len < 0)
    {
      LOG (llevError, "read error on player %s\n",
                      pl && pl->ob ? &pl->ob->name : "[anonymous]");
      destroy ();
      return false;
    }

  inbuf [pkt_len] = 0;      /* Terminate buffer - useful for string data */

  /* First, break out beginning word.  There are at least
   * a few commands that do not have any paremeters.  If
   * we get such a command, don't worry about trying
   * to break it up.
   */
  int datalen;
  char *data = strchr ((char *)inbuf + 2, ' ');

  if (data)
    {
      *data++ = 0;
      datalen = pkt_len - (data - (char *)inbuf);
    }
  else
    {
      data = (char *)inbuf + 2; // better read garbage than segfault
      datalen = 0;
    }

  for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
    if (!strcmp ((char *)inbuf + 2, pkt->name))
      {
        if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
          queue_command (pkt, data, datalen);
        else
          execute (pkt, data, datalen);

        goto next_packet;
      }

  // If we get here, we didn't find a valid command.
  send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED, (char *)inbuf + 2);
next_packet:
  skip_packet (pkt_len);

  // input buffer has space again
  socket_ev.poll (socket_ev.poll () | PE_R);

  return true;
}

// callback called when socket is either readable or writable
void
client::socket_cb (iow &w, int got)
{
  //TODO remove when we have better socket cleanup logic
  if (destroyed ())
    {
      socket_ev.poll (0);
      return;
    }

  if (got & PE_W)
    {
      write_outputbuffer ();

      if (!outputbuffer.len)
        socket_ev.poll (socket_ev.poll () & ~PE_W);
    }

  if (got & PE_R)
    {
      //TODO: rate-limit tcp connection in better ways, important

      int amount = sizeof (inbuf) - inbuf_len;

      if (!amount)
        {
          // input buffer full
          socket_ev.poll (socket_ev.poll () & ~PE_R);
          return;
        }

      amount = read (fd, inbuf + inbuf_len, amount);

      if (!amount)
        {
          destroy ();
          return;
        }
      else if (amount < 0)
        {
          if (errno != EAGAIN && errno != EINTR)
            {
              LOG (llevError, "read error: %s\n", strerror (errno));
              destroy ();
              return;
            }

          // should not be here, normally
        }
      else
        {
          inbuf_len += amount;

          cmd_ev.start ();
        }
    }
}

// called whenever we have additional commands to process
void
client::cmd_cb (iw &w)
{
  if (handle_packet ())
    w.start ();
  else
    flush ();
}

/*******************************************************************************
 *
 * Start of write related routines.
 *
 ******************************************************************************/

/**
 * Adds data to a socket buffer for whatever reason.
 *
 * ns is the socket we are adding the data to, buf is the start of the
 * data, and len is the number of bytes to add.
 */
void
client::send (void *buf_, int len)
{
  char *buf = (char *)buf_;

  if (destroyed () || !buf)
    return;

  if (len + outputbuffer.len > SOCKETBUFSIZE)
    {
      LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
      // shutdown the socket, this is safer than destroying it immediately
      // as lots of code in the callchain might still access the map etc.
      shutdown (fd, SHUT_RDWR);
      return;
    }

  int avail, end;

  /* data + end is where we start putting the new data.  The last byte
   * currently in use is actually data + end -1
   */
  end = outputbuffer.start + outputbuffer.len;
  /* The buffer is already in a wrapped state, so adjust end */
  if (end >= SOCKETBUFSIZE)
    end -= SOCKETBUFSIZE;

  avail = SOCKETBUFSIZE - end;

  /* We can all fit it behind the current data without wrapping */
  if (avail >= len)
    memcpy (outputbuffer.data + end, buf, len);
  else
    {
      memcpy (outputbuffer.data + end, buf, avail);
      memcpy (outputbuffer.data, buf + avail, len - avail);
    }

  outputbuffer.len += len;
}

/**
 * Takes a string of data, and writes it out to the socket. A very handy
 * shortcut function.
 */
void
client::send_packet (packet &sl)
{
  if (destroyed ())
    return;

  if (sl.length () >= MAXSOCKBUF)
    {
      LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
      /* Almost certainly we've overflowed a buffer, so quit now to make
       * it easier to debug.
       */
      abort ();
    }

  if (!sl.length ())
    return;

  assert (sl.hdrlen == 2);

  sl.buf_ [0] = sl.length () >> 8;
  sl.buf_ [1] = sl.length ()     ;

  send (sl.buf_, sl.length () + sl.hdrlen);
}

void
client::send_packet (const char *buf, int len)
{
  packet sl;

  sl << data (buf, len);
  send_packet (sl);
}

void
client::send_packet (const char *buf)
{
  send_packet (buf, strlen (buf));
}

void
client::send_packet_printf (const char *format, ...)
{
  packet sl;

  va_list ap;
  va_start (ap, format);
  sl.vprintf (format, ap);
  va_end (ap);

  send_packet (sl);
}

void
client::send_drawinfo (const char *msg, int flags)
{
  send_packet_printf ("drawinfo %d %s", flags, msg);
}

void
client::send_msg (int color, const char *type, const char *msg)
{
  if (can_msg)
    send_packet_printf ("msg %d %s %s", color, type, msg);
  else if (color < 0)
    return; // client cannot handle this
  else if (strchr (msg, '<') || strchr (msg, '&'))
    {
      //TODO: should escape/modify to old syntax
      send_packet_printf ("drawinfo %d %s", color, msg);
    }
  else
    send_packet_printf ("drawinfo %d %s", color, msg);
}

/***********************************************************************
 *
 * packet functions/utilities
 *
 **********************************************************************/

packet::packet (const char *name)
{
  reset ();

  int len = strlen (name);
  memcpy (cur, name, len); cur += len;
  *cur++ = ' ';
}

packet &packet::operator <<(const ber32 v)
{
  enum { maxlen = 32 / 7 + 1};
  uint8 buf[maxlen];
  uint8 *p = buf + maxlen;
  uint32 val = v.val;

  *--p = val & 0x7F;

  while (val > 0x7F)
    {
      val >>= 7;
      *--p = (val & 0x7F) | 0x80;
    }

  return *this << data (p, buf + maxlen - p);
}

packet &packet::operator <<(const data   &v)
{
  if (room () < v.len)
    reset ();
  else
    {
      if (v.len)
        {
          memcpy (cur, v.ptr, v.len);
          cur += v.len;
        }
    }

  return *this;
}

packet &packet::operator <<(const data8  &v)
{
  unsigned int len = min (v.len, 0x00FF);
  return *this << uint8  (len) << data (v.ptr, len);
}

packet &packet::operator <<(const data16 &v)
{
  unsigned int len = min (v.len, 0xFFFF);
  return *this << uint16 (len) << data (v.ptr, len);
}

packet &packet::operator <<(const char *v)
{
  return *this << data (v, strlen (v ? v : 0));
}

void
packet::vprintf (const char *format, va_list ap)
{
  int size = room ();

  int len = vsnprintf ((char *)cur, size, format, ap);

  if (len >= size)
    return reset ();

  cur += len;
}

Revision:	1.47
Committed:	Tue Jun 12 10:29:52 2007 UTC (16 years, 11 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.46:	+3 -2 lines
Log Message:	only test for timeout and send pseudo-pings when player is active
#	User	Rev	Content
1	elmex	1.1	/*
2	root	1.42	* This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
3	pippijn	1.32	*
4	root	1.42	* Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5			* Copyright (©) 1992,2007 Frank Tore Johansen
6			*
7			* Crossfire TRT is free software; you can redistribute it and/or modify it
8			* under the terms of the GNU General Public License as published by the Free
9			* Software Foundation; either version 2 of the License, or (at your option)
10			* any later version.
11			*
12			* This program is distributed in the hope that it will be useful, but
13			* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14			* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15			* for more details.
16			*
17			* You should have received a copy of the GNU General Public License along
18			* with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
19			* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20	pippijn	1.32	*
21	root	1.42	* The authors can be reached via e-mail to <crossfire@schmorp.de>
22	pippijn	1.32	*/
23	root	1.42
24	elmex	1.1	using namespace std;
25
26			#include <global.h>
27			#include <sproto.h>
28	root	1.11	#include <cstdarg>
29	elmex	1.1
30	root	1.45	#if HAVE_TCP_INFO
31	elmex	1.1	# include <sys/types.h>
32			# include <sys/socket.h>
33			# include <netinet/in.h>
34			# include <netinet/tcp.h>
35			#endif
36
37	root	1.43	// disconnect a socket after this many seconds without an ack
38			#define SOCKET_TIMEOUT 8.
39
40			// force a packet when idle for more than this many seconds,
41			// forcing an ack regularly.
42			#define IDLE_PING 2.
43	elmex	1.1
44	root	1.5	void
45	root	1.22	client::flush ()
46	elmex	1.1	{
47	root	1.29	if (destroyed ())
48			return;
49
50	root	1.45	#if HAVE_TCP_INFO
51	root	1.43	// check about once per second, spread evenly over all clients
52	root	1.47	// do this only when player is active
53			if (!((pticks + fd) & 7) && pl && pl->active)
54	root	1.43	{
55			// check time of last ack, and, if too old, kill connection
56			struct tcp_info tcpi;
57			socklen_t len = sizeof (tcpi);
58	elmex	1.1
59	root	1.43	if (!getsockopt (fd, IPPROTO_TCP, TCP_INFO, &tcpi, &len) && len == sizeof (tcpi))
60			{
61	root	1.46	if (tcpi.tcpi_snd_mss)
62			mss = tcpi.tcpi_snd_mss;
63
64	root	1.43	rtt = tcpi.tcpi_rtt;
65			rttvar = tcpi.tcpi_rttvar;
66	elmex	1.1
67	root	1.43	if (tcpi.tcpi_last_ack_recv > int (SOCKET_TIMEOUT * 1000))
68			{
69			send_msg (NDI_RED, "connection-timeout", "safety disconnect due to tcp/ip timeout (no packets received)");
70			write_outputbuffer ();
71	root	1.21
72	root	1.43	LOG (llevDebug, "connection on fd %d closed due to ack timeout (%u/%u/%u)\n", fd,
73			(unsigned)tcpi.tcpi_last_ack_recv, (unsigned)tcpi.tcpi_last_data_sent, (unsigned)tcpi.tcpi_unacked);
74			destroy ();
75			}
76	elmex	1.1	}
77			}
78	root	1.20	#endif
79
80			/**
81			* Writes data to socket.
82			*
83			* When the socket is clear to write, and we have backlogged data, this
84			* is called to write it out.
85			*/
86
87	root	1.43	// write a nop to the socket at least every IDLE_NOP seconds.
88			if (!outputbuffer.len)
89			{
90	root	1.47	if (last_send + IDLE_PING <= NOW && pl && pl->active)
91	root	1.43	{
92			// this is a bit ugly, but map1/map1a seem to be the only
93			// nop'able commands and they are quite small.
94			packet sl (mapmode == Map1Cmd ? "map1" : "map1a");
95			send_packet (sl);
96			}
97			else
98			return;
99			}
100
101			if (socket_ev.poll () & PE_W)
102	root	1.20	return;
103
104	root	1.43	last_send = NOW;
105	root	1.20	write_outputbuffer ();
106			}
107	elmex	1.1
108	root	1.20	void
109	root	1.22	client::write_outputbuffer ()
110	root	1.20	{
111			while (outputbuffer.len)
112			{
113			int res = write (fd, outputbuffer.data + outputbuffer.start,
114			min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
115	root	1.5
116	root	1.20	if (res > 0)
117			{
118			outputbuffer.start += res;
119			/* wrap back to start of buffer */
120			if (outputbuffer.start == SOCKETBUFSIZE)
121			outputbuffer.start = 0;
122
123			outputbuffer.len -= res;
124			}
125			else if (res == 0)
126			{
127			LOG (llevError, "socket write failed, connection closed.\n");
128	root	1.23	destroy ();
129	root	1.20	return;
130			}
131			else if (errno == EINTR)
132			{
133			// just retry
134			}
135			else if (errno == EAGAIN)
136			{
137			// delay till ready
138			socket_ev.poll (socket_ev.poll () \| PE_W);
139			socket_ev.start ();
140			return;
141			}
142			else
143			{
144			LOG (llevError, "socket write failed: %s\n", strerror (errno));
145	root	1.23	destroy ();
146	root	1.20	return;
147			}
148			}
149
150			socket_ev.poll (socket_ev.poll () & ~PE_W);
151	elmex	1.1	}
152
153	root	1.23	/******************************************************************************
154	elmex	1.1	*
155	root	1.23	* Start of read routines.
156	elmex	1.1	*
157	root	1.23	******************************************************************************/
158	elmex	1.1
159	root	1.23	int
160			client::next_packet ()
161	elmex	1.1	{
162	root	1.23	if (inbuf_len >= 2)
163	root	1.11	{
164	root	1.23	int pkt_len = (inbuf [0] << 8) \| inbuf [1];
165
166			if (inbuf_len >= 2 + pkt_len)
167			return 2 + pkt_len;
168
169			if (inbuf_len == sizeof (inbuf))
170	root	1.15	{
171	root	1.23	send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED);
172			destroy ();
173			return -1;
174	root	1.15	}
175	root	1.11	}
176	root	1.9
177	root	1.23	return 0;
178	root	1.11	}
179	root	1.9
180	root	1.23	void
181			client::skip_packet (int len)
182	root	1.11	{
183	root	1.23	inbuf_len -= len;
184			memmove (inbuf, inbuf + len, inbuf_len);
185	elmex	1.1	}
186
187	root	1.23	/*****************************************************************************
188			* Start of command dispatch area.
189			* The commands here are protocol commands.
190			****************************************************************************/
191
192			// SocketCommand, PlayingCommand, should not exist with those ugly casts
193			#define SC(cb) (void )static_cast<void ()(char , int, client )>(cb),
194			#define PC(cb) (void )static_cast<void ()(char , int, player )>(cb), PF_PLAYER \|
195
196			/**
197			* Dispatch table for the server.
198			*/
199			static struct packet_type packets[] = {
200	root	1.33	{"ncom", PC(NewPlayerCmd) PF_PLAYING \| PF_COMMAND6 },
201			{"command", PC(PlayerCmd) PF_PLAYING \| PF_COMMAND0 },
202	root	1.23
203			{"examine", PC(ExamineCmd) PF_PLAYING },
204	root	1.39	{"ex", PC(ExCmd) PF_PLAYING },
205	root	1.23	{"apply", PC(ApplyCmd) PF_PLAYING },
206			{"lookat", PC(LookAt) PF_PLAYING },
207			{"lock", PC(LockItem) PF_PLAYING },
208			{"mark", PC(MarkItem) PF_PLAYING },
209			{"move", PC(MoveCmd) PF_PLAYING },
210	root	1.39	{"ext", PC(ExtCmd) 0 }, // CF+
211			{"mapredraw", PC(MapRedrawCmd) 0 },
212			{"mapinfo", PC(MapInfoCmd) 0 }, // CF+
213	root	1.23
214	root	1.28	{"reply", SC(ReplyCmd) 0 },
215	root	1.39	{"exti", SC(ExtiCmd) 0 }, // CF+
216	root	1.26	{"addme", SC(AddMeCmd) 0 },
217	root	1.36	{"askface", SC(AskFaceCmd) 0 },
218	root	1.26	{"requestinfo", SC(RequestInfo) 0 },
219			{"setfacemode", SC(SetFaceMode) 0 },
220			{"setsound", SC(SetSound) 0 },
221			{"setup", SC(SetUp) 0 },
222			{"version", SC(VersionCmd) 0 },
223			{"toggleextendedinfos", SC(ToggleExtendedInfos) 0 }, /Added: tchize /
224			{"toggleextendedtext", SC(ToggleExtendedText) 0 }, /Added: tchize /
225			{"asksmooth", SC(AskSmooth) 0 }, /Added: tchize (smoothing technologies) /
226	root	1.23	};
227
228			bool
229			client::may_execute (const packet_type *pkt) const
230	elmex	1.1	{
231	root	1.23	return (!(pkt->flags & PF_PLAYER) \|\| pl)
232	root	1.29	&& (!(pkt->flags & PF_PLAYING) \|\| state == ST_PLAYING);
233	root	1.11	}
234	root	1.9
235	root	1.33	// HACK: some commands currently should be executed
236			// even when the player is frozen. this hack detects
237			// those commands. it should be folded into may_execute,
238			// but kept seperate to emphasise the hack aspect, i.e.
239			// do it better, then remove.
240			static bool
241			always_immediate (const client ns, const packet_type pkt, const char *data, int len)
242			{
243			if (!(pkt->flags & (PF_COMMAND0 \| PF_COMMAND6)))
244			return false;
245
246			if (!ns->pl \|\| !ns->pl->ob \|\| !ns->pl->ob->map)
247			return false;
248
249			if (pkt->flags & PF_COMMAND6)
250			{
251			data += 6;
252			len -= 6;
253			}
254
255			if (len > 4 && !strncmp (data, "say " , 4))
256			return true;
257			if (len > 5 && !strncmp (data, "chat ", 5))
258			return true;
259
260			return false;
261			}
262
263	root	1.23	void
264			client::execute (const packet_type pkt, char data, int datalen)
265	root	1.11	{
266	root	1.33	if (may_execute (pkt) \|\| always_immediate (this, pkt, data, datalen))
267	root	1.23	{
268			//TODO: only one format
269			if (pkt->flags & PF_PLAYER)
270			((void ()(char , int, player ))pkt->cb)((char )data, datalen, pl);
271			else
272			((void ()(char , int, client ))pkt->cb)((char )data, datalen, this);
273			}
274			else
275			send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED, pkt->name);
276	elmex	1.1	}
277
278	root	1.23	bool
279			client::handle_packet ()
280	root	1.10	{
281	root	1.23	int pkt_len = next_packet ();
282
283			if (!pkt_len)
284			return false;
285			else if (pkt_len < 0)
286			{
287			LOG (llevError, "read error on player %s\n",
288			pl && pl->ob ? &pl->ob->name : "[anonymous]");
289			destroy ();
290			return false;
291			}
292
293			inbuf [pkt_len] = 0; /* Terminate buffer - useful for string data */
294
295			/* First, break out beginning word. There are at least
296			* a few commands that do not have any paremeters. If
297			* we get such a command, don't worry about trying
298			* to break it up.
299			*/
300			int datalen;
301			char data = strchr ((char )inbuf + 2, ' ');
302
303			if (data)
304			{
305			*data++ = 0;
306			datalen = pkt_len - (data - (char *)inbuf);
307			}
308			else
309			{
310			data = (char *)inbuf + 2; // better read garbage than segfault
311			datalen = 0;
312			}
313	root	1.15
314	root	1.23	for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
315			if (!strcmp ((char *)inbuf + 2, pkt->name))
316			{
317	root	1.33	if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
318	root	1.26	queue_command (pkt, data, datalen);
319			else
320	root	1.23	execute (pkt, data, datalen);
321
322			goto next_packet;
323			}
324
325	root	1.26	// If we get here, we didn't find a valid command.
326	root	1.23	send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED, (char *)inbuf + 2);
327			next_packet:
328			skip_packet (pkt_len);
329	root	1.11
330	root	1.23	// input buffer has space again
331			socket_ev.poll (socket_ev.poll () \| PE_R);
332	root	1.10
333	root	1.23	return true;
334	root	1.10	}
335
336	root	1.23	// callback called when socket is either readable or writable
337			void
338			client::socket_cb (iow &w, int got)
339			{
340			//TODO remove when we have better socket cleanup logic
341	root	1.29	if (destroyed ())
342	root	1.23	{
343			socket_ev.poll (0);
344			return;
345			}
346	elmex	1.1
347	root	1.23	if (got & PE_W)
348	root	1.5	{
349	root	1.23	write_outputbuffer ();
350
351			if (!outputbuffer.len)
352			socket_ev.poll (socket_ev.poll () & ~PE_W);
353			}
354	root	1.12
355	root	1.23	if (got & PE_R)
356			{
357			//TODO: rate-limit tcp connection in better ways, important
358	pippijn	1.8
359	root	1.12	int amount = sizeof (inbuf) - inbuf_len;
360
361	root	1.23	if (!amount)
362	root	1.5	{
363	root	1.23	// input buffer full
364			socket_ev.poll (socket_ev.poll () & ~PE_R);
365			return;
366	root	1.3	}
367	elmex	1.1
368	root	1.12	amount = read (fd, inbuf + inbuf_len, amount);
369
370			if (!amount)
371	root	1.5	{
372	root	1.23	destroy ();
373			return;
374	root	1.5	}
375	root	1.12	else if (amount < 0)
376	root	1.5	{
377	root	1.12	if (errno != EAGAIN && errno != EINTR)
378	root	1.5	{
379	root	1.20	LOG (llevError, "read error: %s\n", strerror (errno));
380	root	1.23	destroy ();
381			return;
382	root	1.3	}
383	root	1.12
384	root	1.23	// should not be here, normally
385	root	1.3	}
386	root	1.23	else
387			{
388			inbuf_len += amount;
389	root	1.12
390	root	1.23	cmd_ev.start ();
391			}
392	root	1.5	}
393	root	1.12	}
394
395	root	1.23	// called whenever we have additional commands to process
396	root	1.12	void
397	root	1.23	client::cmd_cb (iw &w)
398	root	1.12	{
399	root	1.26	if (handle_packet ())
400	root	1.23	w.start ();
401			else
402			flush ();
403	elmex	1.1	}
404
405			/*******************************************************************************
406			*
407			* Start of write related routines.
408			*
409			******************************************************************************/
410
411			/**
412			* Adds data to a socket buffer for whatever reason.
413			*
414			* ns is the socket we are adding the data to, buf is the start of the
415			* data, and len is the number of bytes to add.
416			*/
417	root	1.20	void
418	root	1.22	client::send (void *buf_, int len)
419	root	1.20	{
420			char buf = (char )buf_;
421	elmex	1.1
422	root	1.29	if (destroyed () \|\| !buf)
423	root	1.23	return;
424	elmex	1.1
425	root	1.31	if (len + outputbuffer.len > SOCKETBUFSIZE)
426	root	1.5	{
427	root	1.23	LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
428	root	1.36	// shutdown the socket, this is safer than destroying it immediately
429			// as lots of code in the callchain might still access the map etc.
430			shutdown (fd, SHUT_RDWR);
431	root	1.5	return;
432			}
433
434	root	1.20	int avail, end;
435
436	root	1.5	/* data + end is where we start putting the new data. The last byte
437			* currently in use is actually data + end -1
438			*/
439	root	1.20	end = outputbuffer.start + outputbuffer.len;
440	root	1.5	/* The buffer is already in a wrapped state, so adjust end */
441			if (end >= SOCKETBUFSIZE)
442			end -= SOCKETBUFSIZE;
443	root	1.7
444	root	1.5	avail = SOCKETBUFSIZE - end;
445	elmex	1.1
446	root	1.5	/* We can all fit it behind the current data without wrapping */
447			if (avail >= len)
448	root	1.20	memcpy (outputbuffer.data + end, buf, len);
449	root	1.5	else
450			{
451	root	1.20	memcpy (outputbuffer.data + end, buf, avail);
452			memcpy (outputbuffer.data, buf + avail, len - avail);
453	elmex	1.1	}
454	root	1.7
455	root	1.20	outputbuffer.len += len;
456	elmex	1.1	}
457
458			/**
459			* Takes a string of data, and writes it out to the socket. A very handy
460			* shortcut function.
461			*/
462	root	1.13	void
463	root	1.22	client::send_packet (packet &sl)
464	root	1.13	{
465	root	1.29	if (destroyed ())
466	root	1.19	return;
467
468			if (sl.length () >= MAXSOCKBUF)
469			{
470			LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
471			/* Almost certainly we've overflowed a buffer, so quit now to make
472			* it easier to debug.
473			*/
474			abort ();
475			}
476
477			if (!sl.length ())
478			return;
479
480			assert (sl.hdrlen == 2);
481
482			sl.buf_ [0] = sl.length () >> 8;
483			sl.buf_ [1] = sl.length () ;
484
485			send (sl.buf_, sl.length () + sl.hdrlen);
486	root	1.13	}
487
488	root	1.5	void
489	root	1.22	client::send_packet (const char *buf, int len)
490	elmex	1.1	{
491	root	1.14	packet sl;
492	elmex	1.1
493	root	1.13	sl << data (buf, len);
494			send_packet (sl);
495	elmex	1.1	}
496
497	root	1.13	void
498	root	1.22	client::send_packet (const char *buf)
499	root	1.13	{
500			send_packet (buf, strlen (buf));
501			}
502	elmex	1.1
503	root	1.23	void
504			client::send_packet_printf (const char *format, ...)
505			{
506			packet sl;
507
508			va_list ap;
509			va_start (ap, format);
510			sl.vprintf (format, ap);
511			va_end (ap);
512
513			send_packet (sl);
514			}
515
516	root	1.35	void
517			client::send_drawinfo (const char *msg, int flags)
518			{
519			send_packet_printf ("drawinfo %d %s", flags, msg);
520			}
521
522	root	1.40	void
523			client::send_msg (int color, const char type, const char msg)
524			{
525			if (can_msg)
526			send_packet_printf ("msg %d %s %s", color, type, msg);
527			else if (color < 0)
528			return; // client cannot handle this
529			else if (strchr (msg, '<') \|\| strchr (msg, '&'))
530			{
531			//TODO: should escape/modify to old syntax
532			send_packet_printf ("drawinfo %d %s", color, msg);
533			}
534			else
535			send_packet_printf ("drawinfo %d %s", color, msg);
536			}
537
538	root	1.23	/***********************************************************************
539			*
540			* packet functions/utilities
541			*
542			**********************************************************************/
543
544	root	1.27	packet::packet (const char *name)
545			{
546			reset ();
547
548			int len = strlen (name);
549			memcpy (cur, name, len); cur += len;
550			*cur++ = ' ';
551			}
552
553	root	1.37	packet &packet::operator <<(const ber32 v)
554			{
555			enum { maxlen = 32 / 7 + 1};
556			uint8 buf[maxlen];
557			uint8 *p = buf + maxlen;
558			uint32 val = v.val;
559
560	root	1.38	*--p = val & 0x7F;
561
562	root	1.37	while (val > 0x7F)
563			{
564	root	1.38	val >>= 7;
565	root	1.37	*--p = (val & 0x7F) \| 0x80;
566			}
567
568			return *this << data (p, buf + maxlen - p);
569			}
570
571	root	1.23	packet &packet::operator <<(const data &v)
572			{
573			if (room () < v.len)
574			reset ();
575			else
576			{
577			if (v.len)
578			{
579			memcpy (cur, v.ptr, v.len);
580			cur += v.len;
581			}
582			}
583
584			return *this;
585			}
586
587			packet &packet::operator <<(const data8 &v)
588			{
589			unsigned int len = min (v.len, 0x00FF);
590			return *this << uint8 (len) << data (v.ptr, len);
591			}
592
593			packet &packet::operator <<(const data16 &v)
594			{
595			unsigned int len = min (v.len, 0xFFFF);
596			return *this << uint16 (len) << data (v.ptr, len);
597			}
598
599			packet &packet::operator <<(const char *v)
600			{
601			return *this << data (v, strlen (v ? v : 0));
602			}
603
604			void
605			packet::vprintf (const char *format, va_list ap)
606			{
607			int size = room ();
608
609			int len = vsnprintf ((char *)cur, size, format, ap);
610
611			if (len >= size)
612			return reset ();
613
614			cur += len;
615			}
616