server/socket/lowlevel.C

/*
 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
 * 
 * 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 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 <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
      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;

          //fprintf (stderr, "uack %d sst %d cwnd %d mss %d pmtu %d\n",
          //         tcpi.tcpi_unacked, tcpi.tcpi_snd_ssthresh, tcpi.tcpi_snd_cwnd, tcpi.tcpi_advmss, tcpi.tcpi_pmtu);

          if (tcpi.tcpi_last_ack_recv > int (SOCKET_TIMEOUT * 1000))
            {
              send_msg (NDI_RED | NDI_REPLY, "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 | NDI_REPLY);
          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 | NDI_REPLY, 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 | NDI_REPLY, (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);
}

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

void
client::send_msg (int color, const char *type, const char *msg)
{
  if (msg_is_special (msg))
    cfperl_send_msg (this, color, type, msg);
  else if (can_msg)
    send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
  else if (color < 0)
    return; // client cannot handle this
  else
    send_packet_printf ("drawinfo %d %s", color & NDI_COLOR_MASK, msg);
}

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