server/socket/image.C

/*
 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
 * 
 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
 * Copyright (©) 2001,2007 Mark Wedel
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Crossfire TRT is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * The authors can be reached via e-mail to <crossfire@schmorp.de>
 */

/** \file
 * Image related communication
 *
 *  \date 2003-12-02
 *
 * This file deals with the image related communication to the
 * client.  I've located all the functions in this file - this
 * localizes it more, and means that we don't need to declare
 * things like all the structures as globals.
 */

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

#include "crc.h"

#define MAX_FACE_SETS   20  /**< Maximum number of image sets the program will handle */

/** Information about one image */
typedef struct FaceInfo
{
  uint8 *data;              /**< image data */
  uint16 datalen;           /**< length of the xpm data */
  uint32 checksum;          /**< Checksum of face data */
} FaceInfo;

/** Information about one face set */
typedef struct
{
  char *prefix;         /**< */
  char *fullname;

  uint8 fallback;       /**< faceset to use when an image is not found in this faceset */
  char *size;
  char *extension;
  char *comment;

  FaceInfo *faces;      /**< images in this faceset */
} FaceSets;

static FaceSets facesets[MAX_FACE_SETS];    /**< All facesets */

/**
 * Checks specified faceset is valid
 * \param fsn faceset number
 */
int
is_valid_faceset (int fsn)
{
  if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix)
    return TRUE;
  return FALSE;
}

/**
 * Frees all faceset information
 */
void
free_socket_images (void)
{
  int num, q;

  for (num = 0; num < MAX_FACE_SETS; num++)
    {
      if (facesets[num].prefix)
        {
          for (q = 0; q < faces.size (); q++)
            if (facesets[num].faces[q].data)
              free (facesets[num].faces[q].data);

          free (facesets[num].prefix);
          free (facesets[num].fullname);
          free (facesets[num].size);
          free (facesets[num].extension);
          free (facesets[num].comment);
          free (facesets[num].faces);
        }
    }
}

/**
 * This returns the set we will actually use when sending
 * a face.  This is used because the image files may be sparse.
 * This function is recursive.  imageno is the face number we are
 * trying to send
 *
 * If face is not found in specified faceset, tries with 'fallback' faceset.
 *
 * \param faceset faceset to check
 * \param imageno image number
 *
 */
static int
get_face_fallback (int faceset, int imageno)
{
  /* faceset 0 is supposed to have every image, so just return.  Doing
   * so also prevents infinite loops in the case if it not having
   * the face, but in that case, we are likely to crash when we try
   * to access the data, but that is probably preferable to an infinite
   * loop.
   */
  if (faceset == 0)
    return 0;

  if (!facesets[faceset].prefix)
    {
      LOG (llevError, "get_face_fallback called with unused set (%d)?\n", faceset);
      return 0;                 /* use default set */
    }

  if (facesets[faceset].faces[imageno].data)
    return faceset;

  return get_face_fallback (facesets[faceset].fallback, imageno);
}

/**
 * Checks fallback are correctly defined.
 * This is a simple recursive function that makes sure the fallbacks
 * are all proper (eg, the fall back to defined sets, and also
 * eventually fall back to 0).  At the top level, togo is set to MAX_FACE_SETS,
 * if togo gets to zero, it means we have a loop.
 * This is only run when we first load the facesets.
 */
static void
check_faceset_fallback (int faceset, int togo)
{
  int fallback = facesets[faceset].fallback;

  /* proper case - falls back to base set */
  if (fallback == 0)
    return;

  if (!facesets[fallback].prefix)
    {
      LOG (llevError, "Face set %d falls to non set faceset %d\n", faceset, fallback);
      abort ();
    }

  togo--;
  if (togo == 0)
    {
      LOG (llevError, "Infinite loop found in facesets. aborting.\n");
      abort ();
    }

  check_faceset_fallback (fallback, togo);
}

#define MAX_IMAGE_SIZE 10000

/**
 * Client tells us what type of faces it wants.  Also sets
 * the caching attribute.
 *
 */
void
SetFaceMode (char *buf, int len, client *ns)
{
  int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);

  if (mode == CF_FACE_NONE)
    ns->facecache = 1;
  else if (mode != CF_FACE_PNG)
    ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode.  Will use Png");

  if (mask)
    ns->facecache = 1;
}

/**
 * client requested an image. send it rate-limited
 * before flushing.
 */
void
AskFaceCmd (char *buf, int len, client *ns)
{
  int idx = 0, pri = 0;

  sscanf (buf, "%d %d", &idx, &pri);

  const facedata *d = face_data (idx, ns->faceset);

  if (!d)
    return; // doh

  client::ixsend ix;

  ix.pri = pri;
  ix.idx = idx;
  ix.ofs = d->data.size ();

  // this is (hopefully) a temporary fix around older cfplus versions not
  // supporting interleaved transfers
  ns->ixface.insert (ns->ixface.begin (), ix);

#if 0
  // the by far most common case will be to insert
  // right at the end, so no looping.
  auto (i, ns->ixface.end ());
  for (; i != ns->ixface.begin (); )
    if (pri >= (--i)->pri)
      break;

  ns->ixface.insert (i, ix);
#endif
}

/**
 * Tells client the picture it has to use 
 * to smooth a picture number given as argument.
 */
void
AskSmooth (char *buf, int len, client *ns)
{
  ns->send_face (atoi (buf));
  ns->flush_fx ();
}

// how lame
static void print_facename (packet &sl, const facedata &d)
{
  for (int i = 0; i < CHKSUM_SIZE; ++i)
    sl.printf ("%02x", d.chksum [i]);
}

// gcfclient uses the server-provided checksum for comparison, but always
// writes a broken checksum to its cache file, so we have to provide
// gcfclient with the same broken (and useless) checksum just to have it
// cache the image despite its bugs.
static uint32 gcfclient_checksum (const facedata *d)
{
  uint32 csum = 0;

  for (std::string::const_iterator i = d->data.begin ();
       i != d->data.end ();
       ++i)
    {
      csum = rotate_right (csum);
      csum += *(uint8 *)&*i;
    }

  return csum;
}

/**
 * Sends a face to a client if they are in pixmap mode
 * nothing gets sent in bitmap mode. 
 * If nocache is true (nonzero), ignore the cache setting from the client -
 * this is needed for the askface, in which we really do want to send the
 * face (and askface is the only place that should be setting it).  Otherwise,
 * we look at the facecache, and if set, send the image name.
 */
void
client::send_face (faceidx facenum)
{
  // never send face 0. ever. it does not exist.
  if (!facenum)
    return;

  const facedata *d = face_data (facenum, faceset);

  if (!d)
    {
      LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum);
      return;
    }

  if (faces_sent[facenum])
    return;

  faces_sent[facenum] = true;

  // if for some reason we let a client without face caching connect,
  // we better support that decision here and implement it.
  if (!facecache)
    return send_image (facenum);

  if (fxix)
    {
      fxface.push_back (facenum);
      return;
    }

  packet sl;

  if (force_face0)
    sl << "face "  << uint16 (facenum);
  else if (image2)
    sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
  else
    sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);

  // how lame
  print_facename (sl, *d);
  send_packet (sl);

  if (EMI_smooth)
    {
      faceinfo *f = face_info (facenum);

      if (f->smooth)
        {
          send_face (f->smooth);

          packet sl ("smooth");

          sl << uint16 (facenum)
             << uint16 (f->smooth);

          send_packet (sl);
        }
    }
}

void client::flush_fx ()
{
  while (!fxface.empty ())
    {
      packet fx ("fx");
      packet sx ("sx");

      do
        {
          faceidx facenum = fxface.back (); fxface.pop_back ();

          const facedata *d = face_data (facenum, faceset);

          if (d)
            {
              fx << ber32 (facenum)
                 << data8 (d->chksum, CHKSUM_SIZE);

              if (smoothing)
                {
                  faceinfo *f = face_info (facenum);

                  if (f->smooth)
                    {
                      send_face (f->smooth);
                      sx << ber32 (facenum)
                         << ber32 (f->smooth)
                         << ber32 (f->smoothlevel);
                    }
                }
            }
        }
      while (!fxface.empty ()
             && fx.room () > ber32::size + CHKSUM_SIZE + 1
             && sx.room () > ber32::size * 3);

      send_packet (fx);
      if (sx.length () > 3) send_packet (sx);
    }
}

void
client::send_image (faceidx facenum)
{
  // never send face 0. ever. it does not exist.
  if (!facenum)
    return;

  const facedata *d = face_data (facenum, faceset);

  faces_sent[facenum] = true;

  if (!d)
    {
      LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
      return;
    }
  
  //TODO: check type here?

  if (force_image_newmap)
    force_newmap = true;

  packet sl;

  sl << (image2 ? "image2 " : "image ")
     << uint32 (facenum);

  if (image2)
    sl << uint8 (0);

  sl << uint32 (d->data.size ())
     << data (d->data.data (), d->data.size ());

  send_packet (sl);
}

// send all faces of this object to the client
// this uses more bandwidth initially, but makes
// animations look much smoother, and every client
// is supposed to do client-side caching anyways.
void
client::send_faces (object *ob)
{
  send_face (ob->face);

  if (ob->animation_id)
    {
      animation &anim = animations [ob->animation_id];

      for (int i = 0; i < anim.num_animations; i++)
        send_face (anim.faces [i]);
    }
}

/**
 * Need to send an animation sequence to the client.
 * We will send appropriate face commands to the client if we haven't
 * sent them the face yet (this can become quite costly in terms of
 * how much we are sending - on the other hand, this should only happen
 * when the player logs in and picks stuff up.
 */
void
client::send_animation (short anim_num)
{
  /* Do some checking on the anim_num we got.  Note that the animations
   * are added in contigous order, so if the number is in the valid
   * range, it must be a valid animation.
   */
  if (anim_num < 0 || anim_num >= animations.size ())
    {
      LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
      return;
    }

  packet sl ("anim");

  sl << uint16 (anim_num)
     << uint16 (0); /* flags - not used right now */

  /* Build up the list of faces.  Also, send any information (ie, the
   * the face itself) down to the client.
   */
  for (int i = 0; i < animations[anim_num].num_animations; i++)
    {
      send_face (animations[anim_num].faces[i]);
      sl << uint16 (animations[anim_num].faces[i]);   /* flags - not used right now */
    }

  send_packet (sl);

  anims_sent[anim_num] = 1;
}

/**
 * Sends the number of images, checksum of the face file,
 * and the image_info file information.  See the doc/Developers/protocol
 * if you want further detail.
 */
void
send_image_info (client *ns, char *params)
{
  packet sl;

  //TODO: second parameter is a checksum, but it makes no sense in this current framework
  sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);

  sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";

  ns->send_packet (sl);
}

/**
 * Sends requested face information.
 * \param ns socket to send to
 * \param params contains first and last index of face
 *
 * For each image in [start..stop] sends
 *  - checksum
 *  - name
 */
void
send_image_sums (client *ns, char *params)
{
  int start, stop;
  char *cp;

  packet sl;

  start = atoi (params);
  for (cp = params; *cp != '\0'; cp++)
    if (*cp == ' ')
      break;

  stop = atoi (cp);
  if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES)
    {
      sl.printf ("replyinfo image_sums %d %d", start, stop);
      ns->send_packet (sl);
      sl.reset ();
      return;
    }

  sl.printf ("replyinfo image_sums %d %d ", start, stop);

  for (int i = start; i <= stop && i < faces.size (); i++)
    {
      ns->faces_sent[i] = true;

      const facedata *d = face_data (i, ns->faceset);

      if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
        break;

      sl << uint16 (i)
         << uint32 (0) // checksum
         << uint8  (ns->faceset);

      print_facename (sl, *d); sl << uint8 (0);
    }

  /* It would make more sense to catch this pre-emptively in the code above.
   * however, if this really happens, we probably just want to cut down the
   * size to less than 1000, since that is what we claim the protocol would
   * support.
   */
  //TODO: taken care of above, should simply abort or make sure the above code is correct
  if (sl.length () >= MAXSOCKBUF)
    {
      LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
      abort ();
    }

  ns->send_packet (sl);
}

Revision:	1.45
Committed:	Thu Jul 5 10:34:08 2007 UTC (16 years, 11 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.44:	+6 -0 lines
Log Message:	- fix rate limiting _again_ (and this time it was an infamous unsigned comparison bug...) - send images strictly in order. this is a bit ugly but temporarily works around older cfplus clients not supporting interleaved transfers.
#	Content
1	/*
2	* This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3	*
4	* Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5	* Copyright (©) 2001,2007 Mark Wedel
6	* Copyright (©) 1992,2007 Frank Tore Johansen
7	*
8	* Crossfire TRT is free software: you can redistribute it and/or modify
9	* it under the terms of the GNU General Public License as published by
10	* the Free Software Foundation, either version 3 of the License, or
11	* (at your option) any later version.
12	*
13	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	* GNU General Public License for more details.
17	*
18	* You should have received a copy of the GNU General Public License
19	* along with this program. If not, see <http://www.gnu.org/licenses/>.
20	*
21	* The authors can be reached via e-mail to <crossfire@schmorp.de>
22	*/
23
24	/** \file
25	* Image related communication
26	*
27	* \date 2003-12-02
28	*
29	* This file deals with the image related communication to the
30	* client. I've located all the functions in this file - this
31	* localizes it more, and means that we don't need to declare
32	* things like all the structures as globals.
33	*/
34
35	#include <global.h>
36	#include <sproto.h>
37
38	#include "crc.h"
39
40	#define MAX_FACE_SETS 20 /*< Maximum number of image sets the program will handle /
41
42	/** Information about one image */
43	typedef struct FaceInfo
44	{
45	uint8 data; /< image data /
46	uint16 datalen; /*< length of the xpm data /
47	uint32 checksum; /*< Checksum of face data /
48	} FaceInfo;
49
50	/** Information about one face set */
51	typedef struct
52	{
53	char prefix; /< /
54	char *fullname;
55
56	uint8 fallback; /*< faceset to use when an image is not found in this faceset /
57	char *size;
58	char *extension;
59	char *comment;
60
61	FaceInfo faces; /< images in this faceset /
62	} FaceSets;
63
64	static FaceSets facesets[MAX_FACE_SETS]; /*< All facesets /
65
66	/**
67	* Checks specified faceset is valid
68	* \param fsn faceset number
69	*/
70	int
71	is_valid_faceset (int fsn)
72	{
73	if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix)
74	return TRUE;
75	return FALSE;
76	}
77
78	/**
79	* Frees all faceset information
80	*/
81	void
82	free_socket_images (void)
83	{
84	int num, q;
85
86	for (num = 0; num < MAX_FACE_SETS; num++)
87	{
88	if (facesets[num].prefix)
89	{
90	for (q = 0; q < faces.size (); q++)
91	if (facesets[num].faces[q].data)
92	free (facesets[num].faces[q].data);
93
94	free (facesets[num].prefix);
95	free (facesets[num].fullname);
96	free (facesets[num].size);
97	free (facesets[num].extension);
98	free (facesets[num].comment);
99	free (facesets[num].faces);
100	}
101	}
102	}
103
104	/**
105	* This returns the set we will actually use when sending
106	* a face. This is used because the image files may be sparse.
107	* This function is recursive. imageno is the face number we are
108	* trying to send
109	*
110	* If face is not found in specified faceset, tries with 'fallback' faceset.
111	*
112	* \param faceset faceset to check
113	* \param imageno image number
114	*
115	*/
116	static int
117	get_face_fallback (int faceset, int imageno)
118	{
119	/* faceset 0 is supposed to have every image, so just return. Doing
120	* so also prevents infinite loops in the case if it not having
121	* the face, but in that case, we are likely to crash when we try
122	* to access the data, but that is probably preferable to an infinite
123	* loop.
124	*/
125	if (faceset == 0)
126	return 0;
127
128	if (!facesets[faceset].prefix)
129	{
130	LOG (llevError, "get_face_fallback called with unused set (%d)?\n", faceset);
131	return 0; /* use default set */
132	}
133
134	if (facesets[faceset].faces[imageno].data)
135	return faceset;
136
137	return get_face_fallback (facesets[faceset].fallback, imageno);
138	}
139
140	/**
141	* Checks fallback are correctly defined.
142	* This is a simple recursive function that makes sure the fallbacks
143	* are all proper (eg, the fall back to defined sets, and also
144	* eventually fall back to 0). At the top level, togo is set to MAX_FACE_SETS,
145	* if togo gets to zero, it means we have a loop.
146	* This is only run when we first load the facesets.
147	*/
148	static void
149	check_faceset_fallback (int faceset, int togo)
150	{
151	int fallback = facesets[faceset].fallback;
152
153	/* proper case - falls back to base set */
154	if (fallback == 0)
155	return;
156
157	if (!facesets[fallback].prefix)
158	{
159	LOG (llevError, "Face set %d falls to non set faceset %d\n", faceset, fallback);
160	abort ();
161	}
162
163	togo--;
164	if (togo == 0)
165	{
166	LOG (llevError, "Infinite loop found in facesets. aborting.\n");
167	abort ();
168	}
169
170	check_faceset_fallback (fallback, togo);
171	}
172
173	#define MAX_IMAGE_SIZE 10000
174
175	/**
176	* Client tells us what type of faces it wants. Also sets
177	* the caching attribute.
178	*
179	*/
180	void
181	SetFaceMode (char buf, int len, client ns)
182	{
183	int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
184
185	if (mode == CF_FACE_NONE)
186	ns->facecache = 1;
187	else if (mode != CF_FACE_PNG)
188	ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
189
190	if (mask)
191	ns->facecache = 1;
192	}
193
194	/**
195	* client requested an image. send it rate-limited
196	* before flushing.
197	*/
198	void
199	AskFaceCmd (char buf, int len, client ns)
200	{
201	int idx = 0, pri = 0;
202
203	sscanf (buf, "%d %d", &idx, &pri);
204
205	const facedata *d = face_data (idx, ns->faceset);
206
207	if (!d)
208	return; // doh
209
210	client::ixsend ix;
211
212	ix.pri = pri;
213	ix.idx = idx;
214	ix.ofs = d->data.size ();
215
216	// this is (hopefully) a temporary fix around older cfplus versions not
217	// supporting interleaved transfers
218	ns->ixface.insert (ns->ixface.begin (), ix);
219
220	#if 0
221	// the by far most common case will be to insert
222	// right at the end, so no looping.
223	auto (i, ns->ixface.end ());
224	for (; i != ns->ixface.begin (); )
225	if (pri >= (--i)->pri)
226	break;
227
228	ns->ixface.insert (i, ix);
229	#endif
230	}
231
232	/**
233	* Tells client the picture it has to use
234	* to smooth a picture number given as argument.
235	*/
236	void
237	AskSmooth (char buf, int len, client ns)
238	{
239	ns->send_face (atoi (buf));
240	ns->flush_fx ();
241	}
242
243	// how lame
244	static void print_facename (packet &sl, const facedata &d)
245	{
246	for (int i = 0; i < CHKSUM_SIZE; ++i)
247	sl.printf ("%02x", d.chksum [i]);
248	}
249
250	// gcfclient uses the server-provided checksum for comparison, but always
251	// writes a broken checksum to its cache file, so we have to provide
252	// gcfclient with the same broken (and useless) checksum just to have it
253	// cache the image despite its bugs.
254	static uint32 gcfclient_checksum (const facedata *d)
255	{
256	uint32 csum = 0;
257
258	for (std::string::const_iterator i = d->data.begin ();
259	i != d->data.end ();
260	++i)
261	{
262	csum = rotate_right (csum);
263	csum += (uint8 )&*i;
264	}
265
266	return csum;
267	}
268
269	/**
270	* Sends a face to a client if they are in pixmap mode
271	* nothing gets sent in bitmap mode.
272	* If nocache is true (nonzero), ignore the cache setting from the client -
273	* this is needed for the askface, in which we really do want to send the
274	* face (and askface is the only place that should be setting it). Otherwise,
275	* we look at the facecache, and if set, send the image name.
276	*/
277	void
278	client::send_face (faceidx facenum)
279	{
280	// never send face 0. ever. it does not exist.
281	if (!facenum)
282	return;
283
284	const facedata *d = face_data (facenum, faceset);
285
286	if (!d)
287	{
288	LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum);
289	return;
290	}
291
292	if (faces_sent[facenum])
293	return;
294
295	faces_sent[facenum] = true;
296
297	// if for some reason we let a client without face caching connect,
298	// we better support that decision here and implement it.
299	if (!facecache)
300	return send_image (facenum);
301
302	if (fxix)
303	{
304	fxface.push_back (facenum);
305	return;
306	}
307
308	packet sl;
309
310	if (force_face0)
311	sl << "face " << uint16 (facenum);
312	else if (image2)
313	sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
314	else
315	sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
316
317	// how lame
318	print_facename (sl, *d);
319	send_packet (sl);
320
321	if (EMI_smooth)
322	{
323	faceinfo *f = face_info (facenum);
324
325	if (f->smooth)
326	{
327	send_face (f->smooth);
328
329	packet sl ("smooth");
330
331	sl << uint16 (facenum)
332	<< uint16 (f->smooth);
333
334	send_packet (sl);
335	}
336	}
337	}
338
339	void client::flush_fx ()
340	{
341	while (!fxface.empty ())
342	{
343	packet fx ("fx");
344	packet sx ("sx");
345
346	do
347	{
348	faceidx facenum = fxface.back (); fxface.pop_back ();
349
350	const facedata *d = face_data (facenum, faceset);
351
352	if (d)
353	{
354	fx << ber32 (facenum)
355	<< data8 (d->chksum, CHKSUM_SIZE);
356
357	if (smoothing)
358	{
359	faceinfo *f = face_info (facenum);
360
361	if (f->smooth)
362	{
363	send_face (f->smooth);
364	sx << ber32 (facenum)
365	<< ber32 (f->smooth)
366	<< ber32 (f->smoothlevel);
367	}
368	}
369	}
370	}
371	while (!fxface.empty ()
372	&& fx.room () > ber32::size + CHKSUM_SIZE + 1
373	&& sx.room () > ber32::size * 3);
374
375	send_packet (fx);
376	if (sx.length () > 3) send_packet (sx);
377	}
378	}
379
380	void
381	client::send_image (faceidx facenum)
382	{
383	// never send face 0. ever. it does not exist.
384	if (!facenum)
385	return;
386
387	const facedata *d = face_data (facenum, faceset);
388
389	faces_sent[facenum] = true;
390
391	if (!d)
392	{
393	LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
394	return;
395	}
396
397	//TODO: check type here?
398
399	if (force_image_newmap)
400	force_newmap = true;
401
402	packet sl;
403
404	sl << (image2 ? "image2 " : "image ")
405	<< uint32 (facenum);
406
407	if (image2)
408	sl << uint8 (0);
409
410	sl << uint32 (d->data.size ())
411	<< data (d->data.data (), d->data.size ());
412
413	send_packet (sl);
414	}
415
416	// send all faces of this object to the client
417	// this uses more bandwidth initially, but makes
418	// animations look much smoother, and every client
419	// is supposed to do client-side caching anyways.
420	void
421	client::send_faces (object *ob)
422	{
423	send_face (ob->face);
424
425	if (ob->animation_id)
426	{
427	animation &anim = animations [ob->animation_id];
428
429	for (int i = 0; i < anim.num_animations; i++)
430	send_face (anim.faces [i]);
431	}
432	}
433
434	/**
435	* Need to send an animation sequence to the client.
436	* We will send appropriate face commands to the client if we haven't
437	* sent them the face yet (this can become quite costly in terms of
438	* how much we are sending - on the other hand, this should only happen
439	* when the player logs in and picks stuff up.
440	*/
441	void
442	client::send_animation (short anim_num)
443	{
444	/* Do some checking on the anim_num we got. Note that the animations
445	* are added in contigous order, so if the number is in the valid
446	* range, it must be a valid animation.
447	*/
448	if (anim_num < 0 \|\| anim_num >= animations.size ())
449	{
450	LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
451	return;
452	}
453
454	packet sl ("anim");
455
456	sl << uint16 (anim_num)
457	<< uint16 (0); /* flags - not used right now */
458
459	/* Build up the list of faces. Also, send any information (ie, the
460	* the face itself) down to the client.
461	*/
462	for (int i = 0; i < animations[anim_num].num_animations; i++)
463	{
464	send_face (animations[anim_num].faces[i]);
465	sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */
466	}
467
468	send_packet (sl);
469
470	anims_sent[anim_num] = 1;
471	}
472
473	/**
474	* Sends the number of images, checksum of the face file,
475	* and the image_info file information. See the doc/Developers/protocol
476	* if you want further detail.
477	*/
478	void
479	send_image_info (client ns, char params)
480	{
481	packet sl;
482
483	//TODO: second parameter is a checksum, but it makes no sense in this current framework
484	sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
485
486	sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
487
488	ns->send_packet (sl);
489	}
490
491	/**
492	* Sends requested face information.
493	* \param ns socket to send to
494	* \param params contains first and last index of face
495	*
496	* For each image in [start..stop] sends
497	* - checksum
498	* - name
499	*/
500	void
501	send_image_sums (client ns, char params)
502	{
503	int start, stop;
504	char *cp;
505
506	packet sl;
507
508	start = atoi (params);
509	for (cp = params; *cp != '\0'; cp++)
510	if (*cp == ' ')
511	break;
512
513	stop = atoi (cp);
514	if (stop < start \|\| *cp == '\0' \|\| (stop - start) > 1000 \|\| stop >= MAX_FACES)
515	{
516	sl.printf ("replyinfo image_sums %d %d", start, stop);
517	ns->send_packet (sl);
518	sl.reset ();
519	return;
520	}
521
522	sl.printf ("replyinfo image_sums %d %d ", start, stop);
523
524	for (int i = start; i <= stop && i < faces.size (); i++)
525	{
526	ns->faces_sent[i] = true;
527
528	const facedata *d = face_data (i, ns->faceset);
529
530	if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
531	break;
532
533	sl << uint16 (i)
534	<< uint32 (0) // checksum
535	<< uint8 (ns->faceset);
536
537	print_facename (sl, *d); sl << uint8 (0);
538	}
539
540	/* It would make more sense to catch this pre-emptively in the code above.
541	* however, if this really happens, we probably just want to cut down the
542	* size to less than 1000, since that is what we claim the protocol would
543	* support.
544	*/
545	//TODO: taken care of above, should simply abort or make sure the above code is correct
546	if (sl.length () >= MAXSOCKBUF)
547	{
548	LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
549	abort ();
550	}
551
552	ns->send_packet (sl);
553	}
554