server/socket/lowlevel.C

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 *
 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 *
 * Deliantra is free software: you can redistribute it and/or modify it under
 * the terms of the Affero 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 Affero GNU General Public License
 * and 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>
 */

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

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

  /**
   * 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_PING seconds.
  if (!outputbuffer.len)
    {
      if (last_send + IDLE_PING <= NOW && pl && pl->active)
        {
          // this is a bit ugly, but map1a seems to be the only
          // nop'able command and it is quite small.
          packet sl ("map1a");
          send_packet (sl);
        }
      else
        return;
    }

  if (socket_ev.poll () & EV_WRITE)
    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 () | EV_WRITE);
          socket_ev.start ();
          return;
        }
      else
        {
          LOG (llevError, "socket write failed: %s\n", strerror (errno));
          destroy ();
          return;
        }
    }

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

/******************************************************************************
 *
 * 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 |

static void
NopCmd (char *, int, client *)
{
  // do nothing
}

/**
 * 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+/Deliantra
  {"mapredraw",   PC(MapRedrawCmd) 0 },
  {"mapinfo",     PC(MapInfoCmd)   0 }, // CF+/Deliantra

  {"reply",       SC(ReplyCmd)     0 },
  {"exti",        SC(ExtiCmd)      0 }, // CF+/Deliantra
  {"addme",       SC(AddMeCmd)     0 },
  {"askface",     SC(AskFaceCmd)   0 },
  {"requestinfo", SC(RequestInfo)  0 },
  {"setsound",    SC(SetSound)     0 },
  {"setup",       SC(SetUp)        0 },
  {"version",     SC(VersionCmd)   0 },

  {"toggleextendedtext", SC(NopCmd)   0 }, // deliantra: disabled
};

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 && data [ 3] == ' ' && !strncmp (data, "say "              ,  4)) return true;
  if (len >  5 && data [ 4] == ' ' && !strncmp (data, "chat "             ,  5)) return true;
  if (len >  6 && data [ 5] == ' ' && !strncmp (data, "shout "            ,  6)) return true;
  if (len >  8 && data [ 7] == ' ' && !strncmp (data, "suicide "          ,  8)) return true;
  if (len > 18 && data [17] == ' ' && !strncmp (data, "accept-invitation ", 18)) return true;

  if (len == 7 && !strcmp (data, "suicide")) 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);
          pl->need_updated_stats ();
        }
      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;
    }

  uint8_t save_byte = inbuf [pkt_len]; // rather ugly
  inbuf [pkt_len] = 0;      /* temporarily 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 + array_length (packets); ++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:
  inbuf [pkt_len] = save_byte; // rather ugly
  skip_packet (pkt_len);

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

  return true;
}

void
client::inbuf_handle ()
{
  if (!handle_packet ())
    return;

  while (handle_packet ())
    ;

  flush ();
}

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

  if (revents & EV_WRITE)
    {
      write_outputbuffer ();

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

  if (revents & EV_READ)
    {
      int amount;
      uint8 *rbuf;

      if (ws_version)
        {
          if (ws_inbuf_len + 2048 > ws_inbuf_alloc)
            ws_inbuf = (uint8 *)realloc (ws_inbuf, ws_inbuf_alloc += 4096);

          rbuf = ws_inbuf + ws_inbuf_len;
          amount = ws_inbuf_alloc - ws_inbuf_len;
        }
      else
        {
          rbuf = inbuf + inbuf_len;
          amount = sizeof (inbuf) - inbuf_len;
        }

      if (!amount)
        {
          // input buffer full
          LOG (llevError, "input buffer overflow.");
          destroy ();
          return;
        }

      amount = read (fd, rbuf, 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
        }

      if (ws_version)
        {
          ws_inbuf_len += amount;

          while (ws_inbuf_len)
            {
              if (ws_inbuf_len < 2 + 4) // 6 is minimum length: op, len, mask
                break;

              int d   = 2;
              int fin = ws_inbuf [0] & 0x80;
              int op  = ws_inbuf [0] & 0x0f;
              int len = ws_inbuf [1] & 0x7f;

              if (len == 126)
                {
                  len = (ws_inbuf [2] << 8) | ws_inbuf [3];
                  d += 2;
                }
              else if (len == 127)
                {
                  if (ws_inbuf_len < 2 + 8)
                    return;

                  // we don't do extra long frames, if a browser wants to send >2**32 bytes,
                  // there are bigger issues to fix.
                  len = (ws_inbuf [8] << 8) |  ws_inbuf [9];
                  d += 8;
                }

              // we only continue if we have a complete frame
              if (ws_inbuf_len < d + 4 + len)
                return;

              switch (op)
                {
                  case  0: op = ws_inbuf_type; break; // continuation
                  case  1: ws_inbuf_type = 1;  break; // utf-8
                  case  2: ws_inbuf_type = 2;  break; // binary
                }

              if (len > sizeof (inbuf) - inbuf_len)
                {
                  // input buffer full
                  LOG (llevError, "input buffer overflow (ws).");
                  destroy ();
                  return;
                }

              uint8 *buf = inbuf + inbuf_len + 2;

              for (int i = 0; i < len; ++i)
                buf [i] = ws_inbuf [d + 4 + i] ^ ws_inbuf [d + (i & 3)];

              // remove frame
              ws_inbuf_len -= d + 4 + len;
              memmove (ws_inbuf, ws_inbuf + d + 4 + len, ws_inbuf_len);

              switch (op)
                {
                  case  1: // utf-8
                    // utf-8 encoded frames cannot have full length (MAXSOCKBUF) in all cases
                    // but we assume that these extra-long packets will be rare.
                    {
                      uint8 *a = buf;
                      uint8 *b = a;
                      uint8 *c = a + len;

                      for (; a < c; ++a, ++b)
                        {
                          *b = *a;

                          if (*a >= 0x80)
                            *b = (a [0] & 0x1f) << 6 | (a [1] & 0x3f), ++a;
                        }

                      len -= a - b;
                    }
                    /* FALLTHROUGH */
                  case  2: // binary
                    inbuf_len += len;

                    if (fin)
                      {
                        inbuf [0] = inbuf_len >> 8;
                        inbuf [1] = inbuf_len;

                        inbuf_len += 2;

                        inbuf_handle ();
                      }
                    break;

                  case 9: // ping
                    {
                      // send pong - we assume ping messages are <64k
                      // as we can't handle >10k at the moment anyway.
                      uint8 hdr [] = { 0x8a, 126, len >> 8, len };
                      send (hdr, sizeof (hdr));
                      send (inbuf + inbuf_len, len);
                    }
                    break;

                  case 10: // pong
                    break;

                  case 8: // close
                  default:
                    destroy ();
                    return;
                }
            }
        }
      else
        {
          inbuf_len += amount;
          inbuf_handle ();
        }
    }
}

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

  if (ws_version == 8)
    {
      static uint8 buf [MAXSOCKBUF * 2 + 4];

      uint8 *b = buf + 4;
      for (uint8 *a = sl.buf_ + sl.hdrlen; a < sl.cur; ++a)
        {
          if (*a < 0x80)
            *b++ = *a;
          else
            {
              *b++ = 0xc0 | ((*a >> 6) & 0x1f);
              *b++ = 0x80 | ( *a       & 0x3f);
            }
        }

      assert (b - buf < sizeof (buf));

      int len = b - (buf + 4);

      if (len < 126)
        {
          buf [2] = 0x81;
          buf [3] = len;

          send (buf + 2, len + 2);
        }
      else
        {
          buf [0] = 0x81;
          buf [1] = 126;
          buf [2] = len >> 8;
          buf [3] = len;

          send (buf, len + 4);
        }
    }
  else if (ws_version == 13)
    {
      int len = sl.length ();

      if (len < 126)
        {
          uint8 hdr [] = { 0x82, len };
          send (hdr, sizeof (hdr));
        }
      else
        {
          uint8 hdr [] = { 0x82, 126, len >> 8, len };
          send (hdr, sizeof (hdr));
        }

      send (sl.buf_ + sl.hdrlen, len);
    }
  else
    {
      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_msg (int color, const char *type, const char *msg)
{
  if (!msg || !type) // it can happen (for example, missing attack messages cause this)
    {
      LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
      return;
    }

  int len = strlen (msg);

  if (!(color & NDI_VERBATIM)
      && (msg_is_special (msg)
          || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128)))
    cfperl_send_msg (this, color, type, msg);
  else
    send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, 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.91
Committed:	Thu Nov 8 02:50:14 2012 UTC (11 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.90:	+3 -3 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	elmex	1.1	/*
2	root	1.62	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	root	1.85	*
4	root	1.84	* Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	root	1.85	*
6	root	1.71	* Deliantra is free software: you can redistribute it and/or modify it under
7			* the terms of the Affero GNU General Public License as published by the
8			* Free Software Foundation, either version 3 of the License, or (at your
9			* option) any later version.
10	root	1.85	*
11	root	1.49	* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15	root	1.85	*
16	root	1.71	* You should have received a copy of the Affero GNU General Public License
17			* and the GNU General Public License along with this program. If not, see
18			* <http://www.gnu.org/licenses/>.
19	root	1.85	*
20	root	1.62	* The authors can be reached via e-mail to <support@deliantra.net>
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	// force a packet when idle for more than this many seconds,
37			// forcing an ack regularly.
38			#define IDLE_PING 2.
39	elmex	1.1
40	root	1.5	void
41	root	1.22	client::flush ()
42	elmex	1.1	{
43	root	1.29	if (destroyed ())
44			return;
45
46	root	1.20	/**
47			* Writes data to socket.
48			*
49			* When the socket is clear to write, and we have backlogged data, this
50			* is called to write it out.
51			*/
52
53	root	1.90	// write a nop to the socket at least every IDLE_PING seconds.
54	root	1.43	if (!outputbuffer.len)
55			{
56	root	1.47	if (last_send + IDLE_PING <= NOW && pl && pl->active)
57	root	1.43	{
58	root	1.82	// this is a bit ugly, but map1a seems to be the only
59			// nop'able command and it is quite small.
60	root	1.80	packet sl ("map1a");
61	root	1.43	send_packet (sl);
62			}
63			else
64			return;
65			}
66
67	root	1.63	if (socket_ev.poll () & EV_WRITE)
68	root	1.20	return;
69
70	root	1.43	last_send = NOW;
71	root	1.20	write_outputbuffer ();
72			}
73	elmex	1.1
74	root	1.20	void
75	root	1.22	client::write_outputbuffer ()
76	root	1.20	{
77			while (outputbuffer.len)
78			{
79			int res = write (fd, outputbuffer.data + outputbuffer.start,
80			min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
81	root	1.5
82	root	1.20	if (res > 0)
83			{
84			outputbuffer.start += res;
85			/* wrap back to start of buffer */
86			if (outputbuffer.start == SOCKETBUFSIZE)
87			outputbuffer.start = 0;
88
89			outputbuffer.len -= res;
90			}
91			else if (res == 0)
92			{
93			LOG (llevError, "socket write failed, connection closed.\n");
94	root	1.23	destroy ();
95	root	1.20	return;
96			}
97			else if (errno == EINTR)
98			{
99			// just retry
100			}
101			else if (errno == EAGAIN)
102			{
103			// delay till ready
104	root	1.63	socket_ev.poll (socket_ev.poll () \| EV_WRITE);
105	root	1.20	socket_ev.start ();
106			return;
107			}
108			else
109			{
110			LOG (llevError, "socket write failed: %s\n", strerror (errno));
111	root	1.23	destroy ();
112	root	1.20	return;
113			}
114			}
115
116	root	1.63	socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
117	elmex	1.1	}
118
119	root	1.23	/******************************************************************************
120	elmex	1.1	*
121	root	1.23	* Start of read routines.
122	elmex	1.1	*
123	root	1.23	******************************************************************************/
124	elmex	1.1
125	root	1.23	int
126			client::next_packet ()
127	elmex	1.1	{
128	root	1.23	if (inbuf_len >= 2)
129	root	1.11	{
130	root	1.23	int pkt_len = (inbuf [0] << 8) \| inbuf [1];
131
132			if (inbuf_len >= 2 + pkt_len)
133			return 2 + pkt_len;
134
135			if (inbuf_len == sizeof (inbuf))
136	root	1.15	{
137	root	1.53	send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED \| NDI_REPLY);
138	root	1.23	destroy ();
139			return -1;
140	root	1.15	}
141	root	1.11	}
142	root	1.9
143	root	1.23	return 0;
144	root	1.11	}
145	root	1.9
146	root	1.23	void
147			client::skip_packet (int len)
148	root	1.11	{
149	root	1.23	inbuf_len -= len;
150			memmove (inbuf, inbuf + len, inbuf_len);
151	elmex	1.1	}
152
153	root	1.23	/*****************************************************************************
154			* Start of command dispatch area.
155			* The commands here are protocol commands.
156			****************************************************************************/
157
158			// SocketCommand, PlayingCommand, should not exist with those ugly casts
159			#define SC(cb) (void )static_cast<void ()(char , int, client )>(cb),
160			#define PC(cb) (void )static_cast<void ()(char , int, player )>(cb), PF_PLAYER \|
161
162	root	1.76	static void
163			NopCmd (char , int, client )
164			{
165			// do nothing
166			}
167
168	root	1.23	/**
169			* Dispatch table for the server.
170			*/
171			static struct packet_type packets[] = {
172	root	1.33	{"ncom", PC(NewPlayerCmd) PF_PLAYING \| PF_COMMAND6 },
173			{"command", PC(PlayerCmd) PF_PLAYING \| PF_COMMAND0 },
174	root	1.23
175			{"examine", PC(ExamineCmd) PF_PLAYING },
176	root	1.39	{"ex", PC(ExCmd) PF_PLAYING },
177	root	1.23	{"apply", PC(ApplyCmd) PF_PLAYING },
178			{"lookat", PC(LookAt) PF_PLAYING },
179			{"lock", PC(LockItem) PF_PLAYING },
180			{"mark", PC(MarkItem) PF_PLAYING },
181			{"move", PC(MoveCmd) PF_PLAYING },
182	root	1.77	{"ext", PC(ExtCmd) 0 }, // CF+/Deliantra
183	root	1.39	{"mapredraw", PC(MapRedrawCmd) 0 },
184	root	1.77	{"mapinfo", PC(MapInfoCmd) 0 }, // CF+/Deliantra
185	root	1.23
186	root	1.28	{"reply", SC(ReplyCmd) 0 },
187	root	1.77	{"exti", SC(ExtiCmd) 0 }, // CF+/Deliantra
188	root	1.26	{"addme", SC(AddMeCmd) 0 },
189	root	1.36	{"askface", SC(AskFaceCmd) 0 },
190	root	1.26	{"requestinfo", SC(RequestInfo) 0 },
191			{"setsound", SC(SetSound) 0 },
192			{"setup", SC(SetUp) 0 },
193			{"version", SC(VersionCmd) 0 },
194	root	1.76
195	root	1.77	{"toggleextendedtext", SC(NopCmd) 0 }, // deliantra: disabled
196	root	1.23	};
197
198			bool
199			client::may_execute (const packet_type *pkt) const
200	elmex	1.1	{
201	root	1.23	return (!(pkt->flags & PF_PLAYER) \|\| pl)
202	root	1.29	&& (!(pkt->flags & PF_PLAYING) \|\| state == ST_PLAYING);
203	root	1.11	}
204	root	1.9
205	root	1.88	// HACK: some commands currently should be executed
206	root	1.33	// even when the player is frozen. this hack detects
207			// those commands. it should be folded into may_execute,
208			// but kept seperate to emphasise the hack aspect, i.e.
209			// do it better, then remove.
210			static bool
211			always_immediate (const client ns, const packet_type pkt, const char *data, int len)
212			{
213			if (!(pkt->flags & (PF_COMMAND0 \| PF_COMMAND6)))
214			return false;
215
216			if (!ns->pl \|\| !ns->pl->ob \|\| !ns->pl->ob->map)
217			return false;
218
219			if (pkt->flags & PF_COMMAND6)
220			{
221			data += 6;
222			len -= 6;
223			}
224
225	root	1.70	if (len > 4 && data [ 3] == ' ' && !strncmp (data, "say " , 4)) return true;
226			if (len > 5 && data [ 4] == ' ' && !strncmp (data, "chat " , 5)) return true;
227			if (len > 6 && data [ 5] == ' ' && !strncmp (data, "shout " , 6)) return true;
228			if (len > 8 && data [ 7] == ' ' && !strncmp (data, "suicide " , 8)) return true;
229			if (len > 18 && data [17] == ' ' && !strncmp (data, "accept-invitation ", 18)) return true;
230	root	1.61
231			if (len == 7 && !strcmp (data, "suicide")) return true;
232	root	1.33
233			return false;
234			}
235
236	root	1.23	void
237			client::execute (const packet_type pkt, char data, int datalen)
238	root	1.11	{
239	root	1.33	if (may_execute (pkt) \|\| always_immediate (this, pkt, data, datalen))
240	root	1.23	{
241			//TODO: only one format
242			if (pkt->flags & PF_PLAYER)
243	root	1.74	{
244			((void ()(char , int, player ))pkt->cb)((char )data, datalen, pl);
245			pl->need_updated_stats ();
246			}
247	root	1.23	else
248			((void ()(char , int, client ))pkt->cb)((char )data, datalen, this);
249			}
250			else
251	root	1.53	send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED \| NDI_REPLY, pkt->name);
252	elmex	1.1	}
253
254	root	1.23	bool
255			client::handle_packet ()
256	root	1.10	{
257	root	1.23	int pkt_len = next_packet ();
258
259			if (!pkt_len)
260			return false;
261			else if (pkt_len < 0)
262			{
263			LOG (llevError, "read error on player %s\n",
264			pl && pl->ob ? &pl->ob->name : "[anonymous]");
265			destroy ();
266			return false;
267			}
268
269	root	1.72	uint8_t save_byte = inbuf [pkt_len]; // rather ugly
270			inbuf [pkt_len] = 0; /* temporarily terminate buffer - useful for string data */
271	root	1.23
272			/* First, break out beginning word. There are at least
273			* a few commands that do not have any paremeters. If
274			* we get such a command, don't worry about trying
275			* to break it up.
276			*/
277			int datalen;
278			char data = strchr ((char )inbuf + 2, ' ');
279
280			if (data)
281			{
282			*data++ = 0;
283			datalen = pkt_len - (data - (char *)inbuf);
284			}
285			else
286			{
287			data = (char *)inbuf + 2; // better read garbage than segfault
288			datalen = 0;
289			}
290	root	1.15
291	root	1.78	for (packet_type *pkt = packets; pkt < packets + array_length (packets); ++pkt)
292	root	1.23	if (!strcmp ((char *)inbuf + 2, pkt->name))
293			{
294	root	1.33	if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
295	root	1.26	queue_command (pkt, data, datalen);
296			else
297	root	1.23	execute (pkt, data, datalen);
298
299			goto next_packet;
300			}
301
302	root	1.26	// If we get here, we didn't find a valid command.
303	root	1.53	send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED \| NDI_REPLY, (char *)inbuf + 2);
304	root	1.72
305	root	1.23	next_packet:
306	root	1.72	inbuf [pkt_len] = save_byte; // rather ugly
307	root	1.23	skip_packet (pkt_len);
308	root	1.11
309	root	1.23	// input buffer has space again
310	root	1.63	socket_ev.poll (socket_ev.poll () \| EV_READ);
311	root	1.10
312	root	1.23	return true;
313	root	1.10	}
314
315	root	1.86	void
316			client::inbuf_handle ()
317			{
318			if (!handle_packet ())
319			return;
320
321			while (handle_packet ())
322			;
323
324			flush ();
325			}
326
327	root	1.23	// callback called when socket is either readable or writable
328			void
329	root	1.63	client::socket_cb (iow &w, int revents)
330	root	1.23	{
331			//TODO remove when we have better socket cleanup logic
332	root	1.29	if (destroyed ())
333	root	1.23	{
334			socket_ev.poll (0);
335			return;
336			}
337	elmex	1.1
338	root	1.63	if (revents & EV_WRITE)
339	root	1.5	{
340	root	1.23	write_outputbuffer ();
341
342			if (!outputbuffer.len)
343	root	1.63	socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
344	root	1.23	}
345	root	1.12
346	root	1.63	if (revents & EV_READ)
347	root	1.23	{
348	root	1.90	int amount;
349			uint8 *rbuf;
350	pippijn	1.8
351	root	1.90	if (ws_version)
352			{
353			if (ws_inbuf_len + 2048 > ws_inbuf_alloc)
354			ws_inbuf = (uint8 *)realloc (ws_inbuf, ws_inbuf_alloc += 4096);
355
356	root	1.91	rbuf = ws_inbuf + ws_inbuf_len;
357	root	1.90	amount = ws_inbuf_alloc - ws_inbuf_len;
358			}
359			else
360			{
361	root	1.91	rbuf = inbuf + inbuf_len;
362	root	1.90	amount = sizeof (inbuf) - inbuf_len;
363			}
364	root	1.12
365	root	1.23	if (!amount)
366	root	1.5	{
367	root	1.23	// input buffer full
368	root	1.87	LOG (llevError, "input buffer overflow.");
369			destroy ();
370	root	1.23	return;
371	root	1.3	}
372	elmex	1.1
373	root	1.91	amount = read (fd, rbuf, amount);
374	root	1.90
375			if (!amount)
376			{
377			destroy ();
378			return;
379			}
380			else if (amount < 0)
381			{
382			if (errno != EAGAIN && errno != EINTR)
383			{
384			LOG (llevError, "read error: %s\n", strerror (errno));
385			destroy ();
386			return;
387			}
388
389			// should not be here, normally
390			}
391
392	root	1.87	if (ws_version)
393			{
394	root	1.90	ws_inbuf_len += amount;
395	root	1.87
396	root	1.90	while (ws_inbuf_len)
397	root	1.87	{
398			if (ws_inbuf_len < 2 + 4) // 6 is minimum length: op, len, mask
399	root	1.90	break;
400	root	1.87
401	root	1.90	int d = 2;
402			int fin = ws_inbuf [0] & 0x80;
403			int op = ws_inbuf [0] & 0x0f;
404			int len = ws_inbuf [1] & 0x7f;
405	root	1.87
406	root	1.90	if (len == 126)
407	root	1.87	{
408	root	1.90	len = (ws_inbuf [2] << 8) \| ws_inbuf [3];
409	root	1.87	d += 2;
410			}
411	root	1.90	else if (len == 127)
412	root	1.87	{
413			if (ws_inbuf_len < 2 + 8)
414			return;
415
416			// we don't do extra long frames, if a browser wants to send >2**32 bytes,
417			// there are bigger issues to fix.
418	root	1.90	len = (ws_inbuf [8] << 8) \| ws_inbuf [9];
419	root	1.87	d += 8;
420			}
421
422			// we only continue if we have a complete frame
423	root	1.90	if (ws_inbuf_len < d + 4 + len)
424	root	1.87	return;
425
426	root	1.90	switch (op)
427	root	1.87	{
428	root	1.90	case 0: op = ws_inbuf_type; break; // continuation
429			case 1: ws_inbuf_type = 1; break; // utf-8
430			case 2: ws_inbuf_type = 2; break; // binary
431	root	1.87	}
432
433	root	1.90	if (len > sizeof (inbuf) - inbuf_len)
434	root	1.87	{
435			// input buffer full
436			LOG (llevError, "input buffer overflow (ws).");
437			destroy ();
438			return;
439			}
440
441	root	1.90	uint8 *buf = inbuf + inbuf_len + 2;
442
443			for (int i = 0; i < len; ++i)
444			buf [i] = ws_inbuf [d + 4 + i] ^ ws_inbuf [d + (i & 3)];
445	root	1.87
446			// remove frame
447	root	1.90	ws_inbuf_len -= d + 4 + len;
448			memmove (ws_inbuf, ws_inbuf + d + 4 + len, ws_inbuf_len);
449	root	1.87
450	root	1.90	switch (op)
451	root	1.87	{
452			case 1: // utf-8
453	root	1.90	// utf-8 encoded frames cannot have full length (MAXSOCKBUF) in all cases
454			// but we assume that these extra-long packets will be rare.
455	root	1.88	{
456	root	1.90	uint8 *a = buf;
457	root	1.88	uint8 *b = a;
458	root	1.90	uint8 *c = a + len;
459	root	1.88
460			for (; a < c; ++a, ++b)
461			{
462			b = a;
463
464			if (*a >= 0x80)
465			*b = (a [0] & 0x1f) << 6 \| (a [1] & 0x3f), ++a;
466			}
467
468	root	1.90	len -= a - b;
469	root	1.88	}
470	root	1.90	/* FALLTHROUGH */
471	root	1.87	case 2: // binary
472	root	1.90	inbuf_len += len;
473
474			if (fin)
475			{
476			inbuf [0] = inbuf_len >> 8;
477			inbuf [1] = inbuf_len;
478
479			inbuf_len += 2;
480
481			inbuf_handle ();
482			}
483	root	1.87	break;
484
485	root	1.90	case 9: // ping
486	root	1.87	{
487			// send pong - we assume ping messages are <64k
488			// as we can't handle >10k at the moment anyway.
489	root	1.90	uint8 hdr [] = { 0x8a, 126, len >> 8, len };
490	root	1.87	send (hdr, sizeof (hdr));
491	root	1.90	send (inbuf + inbuf_len, len);
492	root	1.87	}
493	root	1.90	break;
494	root	1.87
495			case 10: // pong
496	root	1.90	break;
497	root	1.87
498			case 8: // close
499			default:
500			destroy ();
501			return;
502			}
503	root	1.3	}
504			}
505	root	1.23	else
506			{
507			inbuf_len += amount;
508	root	1.86	inbuf_handle ();
509	root	1.23	}
510	root	1.5	}
511	root	1.12	}
512
513	elmex	1.1	/*******************************************************************************
514			*
515			* Start of write related routines.
516			*
517			******************************************************************************/
518
519			/**
520			* Adds data to a socket buffer for whatever reason.
521			*
522			* ns is the socket we are adding the data to, buf is the start of the
523			* data, and len is the number of bytes to add.
524			*/
525	root	1.20	void
526	root	1.22	client::send (void *buf_, int len)
527	root	1.20	{
528			char buf = (char )buf_;
529	elmex	1.1
530	root	1.29	if (destroyed () \|\| !buf)
531	root	1.23	return;
532	elmex	1.1
533	root	1.31	if (len + outputbuffer.len > SOCKETBUFSIZE)
534	root	1.5	{
535	root	1.23	LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
536	root	1.36	// shutdown the socket, this is safer than destroying it immediately
537			// as lots of code in the callchain might still access the map etc.
538			shutdown (fd, SHUT_RDWR);
539	root	1.5	return;
540			}
541
542	root	1.20	int avail, end;
543
544	root	1.5	/* data + end is where we start putting the new data. The last byte
545			* currently in use is actually data + end -1
546			*/
547	root	1.20	end = outputbuffer.start + outputbuffer.len;
548	root	1.5	/* The buffer is already in a wrapped state, so adjust end */
549			if (end >= SOCKETBUFSIZE)
550			end -= SOCKETBUFSIZE;
551	root	1.7
552	root	1.5	avail = SOCKETBUFSIZE - end;
553	elmex	1.1
554	root	1.5	/* We can all fit it behind the current data without wrapping */
555			if (avail >= len)
556	root	1.20	memcpy (outputbuffer.data + end, buf, len);
557	root	1.5	else
558			{
559	root	1.20	memcpy (outputbuffer.data + end, buf, avail);
560			memcpy (outputbuffer.data, buf + avail, len - avail);
561	elmex	1.1	}
562	root	1.7
563	root	1.20	outputbuffer.len += len;
564	elmex	1.1	}
565
566			/**
567			* Takes a string of data, and writes it out to the socket. A very handy
568			* shortcut function.
569			*/
570	root	1.13	void
571	root	1.22	client::send_packet (packet &sl)
572	root	1.13	{
573	root	1.29	if (destroyed ())
574	root	1.19	return;
575
576	root	1.55	if (sl.length () > MAXSOCKBUF)
577	root	1.19	{
578			LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
579			/* Almost certainly we've overflowed a buffer, so quit now to make
580			* it easier to debug.
581			*/
582			abort ();
583			}
584
585			if (!sl.length ())
586			return;
587
588	root	1.87	if (ws_version == 8)
589			{
590	root	1.88	static uint8 buf [MAXSOCKBUF * 2 + 4];
591
592			uint8 *b = buf + 4;
593			for (uint8 *a = sl.buf_ + sl.hdrlen; a < sl.cur; ++a)
594			{
595			if (*a < 0x80)
596			b++ = a;
597			else
598			{
599			b++ = 0xc0 \| ((a >> 6) & 0x1f);
600			b++ = 0x80 \| ( a & 0x3f);
601			}
602			}
603
604			assert (b - buf < sizeof (buf));
605
606	root	1.90	int len = b - (buf + 4);
607	root	1.88
608	root	1.90	if (len < 126)
609	root	1.88	{
610			buf [2] = 0x81;
611	root	1.90	buf [3] = len;
612	root	1.88
613	root	1.90	send (buf + 2, len + 2);
614	root	1.88	}
615			else
616			{
617			buf [0] = 0x81;
618			buf [1] = 126;
619	root	1.90	buf [2] = len >> 8;
620			buf [3] = len;
621	root	1.88
622	root	1.90	send (buf, len + 4);
623	root	1.88	}
624	root	1.87	}
625			else if (ws_version == 13)
626			{
627	root	1.90	int len = sl.length ();
628	root	1.88
629	root	1.90	if (len < 126)
630	root	1.88	{
631	root	1.90	uint8 hdr [] = { 0x82, len };
632	root	1.88	send (hdr, sizeof (hdr));
633			}
634			else
635			{
636	root	1.90	uint8 hdr [] = { 0x82, 126, len >> 8, len };
637	root	1.88	send (hdr, sizeof (hdr));
638			}
639
640	root	1.90	send (sl.buf_ + sl.hdrlen, len);
641	root	1.87	}
642			else
643			{
644			assert (sl.hdrlen == 2);
645	root	1.19
646	root	1.87	sl.buf_ [0] = sl.length () >> 8;
647			sl.buf_ [1] = sl.length () ;
648	root	1.19
649	root	1.87	send (sl.buf_, sl.length () + sl.hdrlen);
650			}
651	root	1.13	}
652
653	root	1.5	void
654	root	1.22	client::send_packet (const char *buf, int len)
655	elmex	1.1	{
656	root	1.14	packet sl;
657	elmex	1.1
658	root	1.13	sl << data (buf, len);
659			send_packet (sl);
660	elmex	1.1	}
661
662	root	1.13	void
663	root	1.22	client::send_packet (const char *buf)
664	root	1.13	{
665			send_packet (buf, strlen (buf));
666			}
667	elmex	1.1
668	root	1.23	void
669			client::send_packet_printf (const char *format, ...)
670			{
671			packet sl;
672
673			va_list ap;
674			va_start (ap, format);
675			sl.vprintf (format, ap);
676			va_end (ap);
677
678			send_packet (sl);
679			}
680
681	root	1.40	void
682			client::send_msg (int color, const char type, const char msg)
683			{
684	root	1.58	if (!msg \|\| !type) // it can happen (for example, missing attack messages cause this)
685			{
686			LOG (logBacktrace \| llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
687			return;
688			}
689
690	root	1.59	int len = strlen (msg);
691
692	root	1.66	if (!(color & NDI_VERBATIM)
693			&& (msg_is_special (msg)
694			\|\| (type [0] == 'c' && type [1] == '/') \|\| len > (MAXSOCKBUF - 128)))
695	root	1.48	cfperl_send_msg (this, color, type, msg);
696	root	1.69	else
697	root	1.53	send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
698	root	1.40	}
699
700	root	1.48	void
701			client::send_drawinfo (const char *msg, int flags)
702			{
703			send_msg (flags, "log", msg);
704			}
705
706	root	1.23	/***********************************************************************
707			*
708			* packet functions/utilities
709			*
710			**********************************************************************/
711
712	root	1.27	packet::packet (const char *name)
713			{
714			reset ();
715
716			int len = strlen (name);
717			memcpy (cur, name, len); cur += len;
718			*cur++ = ' ';
719			}
720
721	root	1.37	packet &packet::operator <<(const ber32 v)
722			{
723	root	1.79	enum { maxlen = 32 / 7 + 1 };
724	root	1.37	uint8 buf[maxlen];
725			uint8 *p = buf + maxlen;
726			uint32 val = v.val;
727
728	root	1.38	*--p = val & 0x7F;
729
730	root	1.37	while (val > 0x7F)
731			{
732	root	1.38	val >>= 7;
733	root	1.37	*--p = (val & 0x7F) \| 0x80;
734			}
735
736			return *this << data (p, buf + maxlen - p);
737			}
738
739	root	1.23	packet &packet::operator <<(const data &v)
740			{
741			if (room () < v.len)
742			reset ();
743			else
744			{
745			if (v.len)
746			{
747			memcpy (cur, v.ptr, v.len);
748			cur += v.len;
749			}
750			}
751
752			return *this;
753			}
754
755			packet &packet::operator <<(const data8 &v)
756			{
757			unsigned int len = min (v.len, 0x00FF);
758			return *this << uint8 (len) << data (v.ptr, len);
759			}
760
761			packet &packet::operator <<(const data16 &v)
762			{
763			unsigned int len = min (v.len, 0xFFFF);
764			return *this << uint16 (len) << data (v.ptr, len);
765			}
766
767			packet &packet::operator <<(const char *v)
768			{
769			return *this << data (v, strlen (v ? v : 0));
770			}
771
772			void
773			packet::vprintf (const char *format, va_list ap)
774			{
775			int size = room ();
776
777			int len = vsnprintf ((char *)cur, size, format, ap);
778
779			if (len >= size)
780			return reset ();
781
782			cur += len;
783			}
784