server/socket/loop.C

/*
    CrossFire, A Multiplayer game for X-windows

    Copyright (C) 2002-2003 Mark Wedel & The Crossfire Development Team
    Copyright (C) 1992 Frank Tore Johansen

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    The author can be reached via e-mail to <crossfire@schmorp.de>
*/

/**
 * \file
 * Main client/server loops.
 *
 * \date 2003-12-02
 *
 * loop.c mainly deals with initialization and higher level socket
 * maintenance (checking for lost connections and if data has arrived.)
 * The reading of data is handled in ericserver.c
 */


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

#include <sys/types.h>
#include <sys/time.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netdb.h>

#include <unistd.h>
#include <arpa/inet.h>

#include <loader.h>

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

/* Either keep this near the start or end of the file so it is
 * at least reasonablye easy to find.
 * There are really 2 commands - those which are sent/received
 * before player joins, and those happen after the player has joined.
 * As such, we have function types that might be called, so
 * we end up having 2 tables.
 */

enum {
  PF_PLAYER    = 0x01, // must have valid player
  PF_IMMEDIATE = 0x02, // TODO: hack, can be executed immediately
  PF_PLAYING   = 0x04, // must be in playing state
};

struct pkt_type
{
  const char *name;
  void *cb;
  int flags;

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

  void execute (client *ns, char *data, int datalen)
  {
    //TODO: only one format
    if (flags & PF_PLAYER)
      ((void (*)(char *, int, player *       ))cb)((char *)data, datalen, ns->pl);
    else
      ((void (*)(char *, int, client *))cb)((char *)data, datalen, ns);
  }
};

// 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 pkt_type packets[] = {
  {"ncom",        PC(NewPlayerCmd) PF_PLAYING },
  {"command",     PC(PlayerCmd)    PF_PLAYING },

  {"examine",     PC(ExamineCmd)   PF_PLAYING | PF_IMMEDIATE },
  {"apply",       PC(ApplyCmd)     PF_PLAYING | PF_IMMEDIATE },
  {"reply",       PC(ReplyCmd)     PF_IMMEDIATE },
  {"lookat",      PC(LookAt)       PF_PLAYING | PF_IMMEDIATE },
  {"lock",        PC(LockItem)     PF_PLAYING | PF_IMMEDIATE },
  {"mark",        PC(MarkItem)     PF_PLAYING | PF_IMMEDIATE },
  {"move",        PC(MoveCmd)      PF_PLAYING | PF_IMMEDIATE },
  {"ext",         PC(ExtCmd)       PF_IMMEDIATE },           /* CF+ */
  {"mapredraw",   PC(MapRedrawCmd) PF_IMMEDIATE },       /* Added: phil */
  {"mapinfo",     PC(MapInfoCmd)   PF_IMMEDIATE },   /* CF+ */

  {"addme",       SC(AddMeCmd)     PF_IMMEDIATE },
  {"askface",     SC(SendFaceCmd)  0 },     /* Added: phil */
  {"requestinfo", SC(RequestInfo)  0 },
  {"setfacemode", SC(SetFaceMode)  PF_IMMEDIATE },
  {"setsound",    SC(SetSound)     PF_IMMEDIATE },
  {"setup",       SC(SetUp)        PF_IMMEDIATE },
  {"version",     SC(VersionCmd)   PF_IMMEDIATE },
  {"toggleextendedinfos", SC(ToggleExtendedInfos) PF_IMMEDIATE }, /*Added: tchize */
  {"toggleextendedtext",  SC(ToggleExtendedText)  PF_IMMEDIATE },   /*Added: tchize */
  {"asksmooth",   SC(AskSmooth)    0 },     /*Added: tchize (smoothing technologies) */
};

/**
 * Handle client input.
 *
 * HandleClient is actually not named really well - we only get here once
 * there is input, so we don't do exception or other stuff here.
 * sock is the output socket information.  pl is the player associated
 * with this socket, null if no player (one of the init_sockets for just
 * starting a connection)
 */
void
HandleClient (client *ns, player *pl)
{
  /* Loop through this - maybe we have several complete packets here. */
  // limit to a few commands only, though, as to not monopolise the server
  for (int repeat = 16; repeat--;)
    {
      /* If it is a player, and they don't have any speed left, we
       * return, and will read in the data when they do have time.
       */
      if (pl && pl->state == ST_PLAYING && pl->ob && pl->ob->speed_left < 0)
        return;

      int pkt_len = ns->read_packet ();

      if (pkt_len < 0)
        {
          LOG (llevError, "read error on player %s\n", &pl->ob->name);
          /* Caller will take care of cleaning this up */
          ns->status = Ns_Dead;
          return;
        }
      else if (pkt_len == 0)
        /* Still dont have a full packet */
        return;

      /* 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 *)ns->inbuf + 2, ' ');

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

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

      for (pkt_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
        if (!strcmp ((char *)ns->inbuf + 2, pkt->name))
          {
            if (pkt->may_execute (ns))
              {
                pkt->execute (ns, data, datalen);
                ns->skip_packet (pkt_len);
                //D//TODO not doing this causes random memory corruption
                if (pkt->flags & PF_IMMEDIATE)
                  goto next_packet;
                return;
              }
          }

      /* If we get here, we didn't find a valid command.  Logging
       * this might be questionable, because a broken client/malicious
       * user could certainly send a whole bunch of invalid commands.
       */
      LOG (llevDebug, "Bad command from client (%s)\n", ns->inbuf + 2);
      ns->skip_packet (pkt_len);
    next_packet:
      ;
    }
}

void
flush_sockets (void)
{
  for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
    if ((*i)->status != Ns_Dead)
      (*i)->flush ();
}

/**
 * This checks the sockets for input, does the right thing.
 *
 * A bit of this code is grabbed out of socket.c
 * There are 2 lists we need to look through - init_sockets is a list
 * 
 */
void
doeric_server (void)
{
  int i, pollret;
  fd_set tmp_read;
  struct sockaddr_in addr;
  socklen_t addrlen = sizeof (struct sockaddr);
  player *pl, *next;
  int maxfd = 0;

#ifdef CS_LOGSTATS
  if ((time (NULL) - cst_lst.time_start) >= CS_LOGTIME)
    write_cs_stats ();
#endif

  /* Go through the players.  Let the loop set the next pl value,
   * since we may remove some
   */
  //TODO: must be handled cleanly elsewhere
  for (pl = first_player; pl; )
    {
      player *npl = pl->next;

      //TODO: must be handled cleanly elsewhere
      if (pl->socket->status == Ns_Dead)
        {
          save_player (pl->ob, 0);

          if (!QUERY_FLAG (pl->ob, FLAG_REMOVED))
            {
              terminate_all_pets (pl->ob);
              pl->ob->remove ();
            }

          leave (pl, 1);
          final_free_player (pl);
        }

      pl = npl;
    }

  FD_ZERO (&tmp_read);

  for (sockvec::iterator i = clients.begin (); i != clients.end (); )
    {
      client *s = *i;

      if (s->status == Ns_Dead)
        {
          clients.erase (i);
          delete s;
        }
      else
        {
          if (s->fd > maxfd) maxfd = s->fd;

          FD_SET (s->fd, &tmp_read);

          ++i;
        }
    }

  struct timeval timeout;

  timeout.tv_sec  = 0;
  timeout.tv_usec = 0;

  pollret = select (maxfd + 1,
                    &tmp_read, 0, 0,
                    &timeout);

  if (pollret == -1)
    {
      LOG (llevError, "select failed: %s\n", strerror (errno));
      return;
    }

  /* We need to do some of the processing below regardless */

  /* Check for any input on the sockets */
  for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
    {
      client *s = *i;
      player *pl = s->pl;

      //TODO: disassociate handleclient from socket readin
      if (s->inbuf_len || FD_ISSET (s->fd, &tmp_read))
        HandleClient (s, pl);

      //TODO: should not be done here, either
      if (s->status != Ns_Dead && pl)
        {
          /* Update the players stats once per tick.  More efficient than
           * sending them whenever they change, and probably just as useful
           */
          esrv_update_stats (pl);
          if (pl->last_weight != -1 && pl->last_weight != WEIGHT (pl->ob))
            {
              esrv_update_item (UPD_WEIGHT, pl->ob, pl->ob);
              if (pl->last_weight != WEIGHT (pl->ob))
                LOG (llevError, "esrv_update_item(UPD_WEIGHT) did not set player weight: is %lu, should be %lu\n",
                     (unsigned long) pl->last_weight, WEIGHT (pl->ob));
            }

          /* draw_client_map does sanity checking that map is
           * valid, so don't do it here.
           */
          draw_client_map (pl->ob);
          if (s->update_look)
            esrv_draw_look (pl->ob);
        }
    }
}

Revision:	1.19
Committed:	Fri Dec 15 19:59:20 2006 UTC (17 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.18:	+11 -13 lines
Log Message:	the rename for sanity campaign hits you died - renamed stuff - partially updated copyrights - some cleanups
#	Content
1	/*
2	CrossFire, A Multiplayer game for X-windows
3
4	Copyright (C) 2002-2003 Mark Wedel & The Crossfire Development Team
5	Copyright (C) 1992 Frank Tore Johansen
6
7	This program 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 2 of the License, or
10	(at your 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 GNU General Public License
18	along with this program; if not, write to the Free Software
19	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
21	The author can be reached via e-mail to <crossfire@schmorp.de>
22	*/
23
24	/**
25	* \file
26	* Main client/server loops.
27	*
28	* \date 2003-12-02
29	*
30	* loop.c mainly deals with initialization and higher level socket
31	* maintenance (checking for lost connections and if data has arrived.)
32	* The reading of data is handled in ericserver.c
33	*/
34
35
36	#include <global.h>
37	#include <sproto.h>
38	#include <sockproto.h>
39
40	#include <sys/types.h>
41	#include <sys/time.h>
42	#include <sys/socket.h>
43	#include <netinet/in.h>
44	#include <netdb.h>
45
46	#include <unistd.h>
47	#include <arpa/inet.h>
48
49	#include <loader.h>
50
51	/*****************************************************************************
52	* Start of command dispatch area.
53	* The commands here are protocol commands.
54	****************************************************************************/
55
56	/* Either keep this near the start or end of the file so it is
57	* at least reasonablye easy to find.
58	* There are really 2 commands - those which are sent/received
59	* before player joins, and those happen after the player has joined.
60	* As such, we have function types that might be called, so
61	* we end up having 2 tables.
62	*/
63
64	enum {
65	PF_PLAYER = 0x01, // must have valid player
66	PF_IMMEDIATE = 0x02, // TODO: hack, can be executed immediately
67	PF_PLAYING = 0x04, // must be in playing state
68	};
69
70	struct pkt_type
71	{
72	const char *name;
73	void *cb;
74	int flags;
75
76	bool may_execute (client *ns)
77	{
78	return (!(flags & PF_PLAYER) \|\| ns->pl)
79	&& (!(flags & PF_PLAYING) \|\| (ns->pl && ns->pl->state == ST_PLAYING));
80	}
81
82	void execute (client ns, char data, int datalen)
83	{
84	//TODO: only one format
85	if (flags & PF_PLAYER)
86	((void ()(char , int, player * ))cb)((char *)data, datalen, ns->pl);
87	else
88	((void ()(char , int, client ))cb)((char )data, datalen, ns);
89	}
90	};
91
92	// SocketCommand, PlayingCommand, should not exist with those ugly casts
93	#define SC(cb) (void )static_cast<void ()(char , int, client )>(cb),
94	#define PC(cb) (void )static_cast<void ()(char , int, player )>(cb), PF_PLAYER \|
95
96	/**
97	* Dispatch table for the server.
98	*/
99	static struct pkt_type packets[] = {
100	{"ncom", PC(NewPlayerCmd) PF_PLAYING },
101	{"command", PC(PlayerCmd) PF_PLAYING },
102
103	{"examine", PC(ExamineCmd) PF_PLAYING \| PF_IMMEDIATE },
104	{"apply", PC(ApplyCmd) PF_PLAYING \| PF_IMMEDIATE },
105	{"reply", PC(ReplyCmd) PF_IMMEDIATE },
106	{"lookat", PC(LookAt) PF_PLAYING \| PF_IMMEDIATE },
107	{"lock", PC(LockItem) PF_PLAYING \| PF_IMMEDIATE },
108	{"mark", PC(MarkItem) PF_PLAYING \| PF_IMMEDIATE },
109	{"move", PC(MoveCmd) PF_PLAYING \| PF_IMMEDIATE },
110	{"ext", PC(ExtCmd) PF_IMMEDIATE }, /* CF+ */
111	{"mapredraw", PC(MapRedrawCmd) PF_IMMEDIATE }, /* Added: phil */
112	{"mapinfo", PC(MapInfoCmd) PF_IMMEDIATE }, /* CF+ */
113
114	{"addme", SC(AddMeCmd) PF_IMMEDIATE },
115	{"askface", SC(SendFaceCmd) 0 }, /* Added: phil */
116	{"requestinfo", SC(RequestInfo) 0 },
117	{"setfacemode", SC(SetFaceMode) PF_IMMEDIATE },
118	{"setsound", SC(SetSound) PF_IMMEDIATE },
119	{"setup", SC(SetUp) PF_IMMEDIATE },
120	{"version", SC(VersionCmd) PF_IMMEDIATE },
121	{"toggleextendedinfos", SC(ToggleExtendedInfos) PF_IMMEDIATE }, /Added: tchize /
122	{"toggleextendedtext", SC(ToggleExtendedText) PF_IMMEDIATE }, /Added: tchize /
123	{"asksmooth", SC(AskSmooth) 0 }, /Added: tchize (smoothing technologies) /
124	};
125
126	/**
127	* Handle client input.
128	*
129	* HandleClient is actually not named really well - we only get here once
130	* there is input, so we don't do exception or other stuff here.
131	* sock is the output socket information. pl is the player associated
132	* with this socket, null if no player (one of the init_sockets for just
133	* starting a connection)
134	*/
135	void
136	HandleClient (client ns, player pl)
137	{
138	/* Loop through this - maybe we have several complete packets here. */
139	// limit to a few commands only, though, as to not monopolise the server
140	for (int repeat = 16; repeat--;)
141	{
142	/* If it is a player, and they don't have any speed left, we
143	* return, and will read in the data when they do have time.
144	*/
145	if (pl && pl->state == ST_PLAYING && pl->ob && pl->ob->speed_left < 0)
146	return;
147
148	int pkt_len = ns->read_packet ();
149
150	if (pkt_len < 0)
151	{
152	LOG (llevError, "read error on player %s\n", &pl->ob->name);
153	/* Caller will take care of cleaning this up */
154	ns->status = Ns_Dead;
155	return;
156	}
157	else if (pkt_len == 0)
158	/* Still dont have a full packet */
159	return;
160
161	/* First, break out beginning word. There are at least
162	* a few commands that do not have any paremeters. If
163	* we get such a command, don't worry about trying
164	* to break it up.
165	*/
166	int datalen;
167	char data = strchr ((char )ns->inbuf + 2, ' ');
168
169	if (data)
170	{
171	*data++ = 0;
172	datalen = pkt_len - (data - (char *)ns->inbuf);
173	}
174	else
175	{
176	data = (char *)ns->inbuf + 2; // better read garbage than segfault
177	datalen = 0;
178	}
179
180	ns->inbuf [pkt_len] = 0; /* Terminate buffer - useful for string data */
181
182	for (pkt_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
183	if (!strcmp ((char *)ns->inbuf + 2, pkt->name))
184	{
185	if (pkt->may_execute (ns))
186	{
187	pkt->execute (ns, data, datalen);
188	ns->skip_packet (pkt_len);
189	//D//TODO not doing this causes random memory corruption
190	if (pkt->flags & PF_IMMEDIATE)
191	goto next_packet;
192	return;
193	}
194	}
195
196	/* If we get here, we didn't find a valid command. Logging
197	* this might be questionable, because a broken client/malicious
198	* user could certainly send a whole bunch of invalid commands.
199	*/
200	LOG (llevDebug, "Bad command from client (%s)\n", ns->inbuf + 2);
201	ns->skip_packet (pkt_len);
202	next_packet:
203	;
204	}
205	}
206
207	void
208	flush_sockets (void)
209	{
210	for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
211	if ((*i)->status != Ns_Dead)
212	(*i)->flush ();
213	}
214
215	/**
216	* This checks the sockets for input, does the right thing.
217	*
218	* A bit of this code is grabbed out of socket.c
219	* There are 2 lists we need to look through - init_sockets is a list
220	*
221	*/
222	void
223	doeric_server (void)
224	{
225	int i, pollret;
226	fd_set tmp_read;
227	struct sockaddr_in addr;
228	socklen_t addrlen = sizeof (struct sockaddr);
229	player pl, next;
230	int maxfd = 0;
231
232	#ifdef CS_LOGSTATS
233	if ((time (NULL) - cst_lst.time_start) >= CS_LOGTIME)
234	write_cs_stats ();
235	#endif
236
237	/* Go through the players. Let the loop set the next pl value,
238	* since we may remove some
239	*/
240	//TODO: must be handled cleanly elsewhere
241	for (pl = first_player; pl; )
242	{
243	player *npl = pl->next;
244
245	//TODO: must be handled cleanly elsewhere
246	if (pl->socket->status == Ns_Dead)
247	{
248	save_player (pl->ob, 0);
249
250	if (!QUERY_FLAG (pl->ob, FLAG_REMOVED))
251	{
252	terminate_all_pets (pl->ob);
253	pl->ob->remove ();
254	}
255
256	leave (pl, 1);
257	final_free_player (pl);
258	}
259
260	pl = npl;
261	}
262
263	FD_ZERO (&tmp_read);
264
265	for (sockvec::iterator i = clients.begin (); i != clients.end (); )
266	{
267	client s = i;
268
269	if (s->status == Ns_Dead)
270	{
271	clients.erase (i);
272	delete s;
273	}
274	else
275	{
276	if (s->fd > maxfd) maxfd = s->fd;
277
278	FD_SET (s->fd, &tmp_read);
279
280	++i;
281	}
282	}
283
284	struct timeval timeout;
285
286	timeout.tv_sec = 0;
287	timeout.tv_usec = 0;
288
289	pollret = select (maxfd + 1,
290	&tmp_read, 0, 0,
291	&timeout);
292
293	if (pollret == -1)
294	{
295	LOG (llevError, "select failed: %s\n", strerror (errno));
296	return;
297	}
298
299	/* We need to do some of the processing below regardless */
300
301	/* Check for any input on the sockets */
302	for (sockvec::iterator i = clients.begin (); i != clients.end (); ++i)
303	{
304	client s = i;
305	player *pl = s->pl;
306
307	//TODO: disassociate handleclient from socket readin
308	if (s->inbuf_len \|\| FD_ISSET (s->fd, &tmp_read))
309	HandleClient (s, pl);
310
311	//TODO: should not be done here, either
312	if (s->status != Ns_Dead && pl)
313	{
314	/* Update the players stats once per tick. More efficient than
315	* sending them whenever they change, and probably just as useful
316	*/
317	esrv_update_stats (pl);
318	if (pl->last_weight != -1 && pl->last_weight != WEIGHT (pl->ob))
319	{
320	esrv_update_item (UPD_WEIGHT, pl->ob, pl->ob);
321	if (pl->last_weight != WEIGHT (pl->ob))
322	LOG (llevError, "esrv_update_item(UPD_WEIGHT) did not set player weight: is %lu, should be %lu\n",
323	(unsigned long) pl->last_weight, WEIGHT (pl->ob));
324	}
325
326	/* draw_client_map does sanity checking that map is
327	* valid, so don't do it here.
328	*/
329	draw_client_map (pl->ob);
330	if (s->update_look)
331	esrv_draw_look (pl->ob);
332	}
333	}
334	}
335