server/socket/image.C

/*
 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
 * 
 * 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 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 Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * 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 ();

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

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