server/socket/lowlevel.C

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 *
 * Copyright (©) 2018 Marc Alexander Lehmann / the Deliantra team
 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 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>
 */

#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

using namespace std;

// 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 ("msg %d log 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[] = {
  {"command",     PC(PlayerCmd)    PF_PLAYING | PF_COMMAND },

  {"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_COMMAND))
    return false;

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

  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 ("msg %d log 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 + ecb_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 ("msg %d log 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_n (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);
}

/***********************************************************************
 *
 * 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_n (p, buf + maxlen - p);
}

packet &packet::operator <<(const data_n &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_n (v.ptr, len);
}

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

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