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 ();

  auto (pos, ns->ixface.end ());

  if (ns->fxix < 2)
    {
      // gcfclient does not support prioritising, older cfplus versions
      // do not support interleaved transfers.
      if (!ns->ixface.empty ())
        pos = ns->ixface.end () - 1;
    }
  else
    {
      // the by far most common case will be to insert
      // near the end, so little looping.
      while (pos != ns->ixface.begin ())
        {
          --pos;

          // sort within 2k bins, to slightly prefer smaller images
          if (pri > pos->pri || (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11)))
            {
              ++pos;
              break;
            }
        }
    }

  ns->ixface.insert (pos, ix);

#if 0
  for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i)
    fprintf (stderr, "<%d,%d> ",  i->pri, i->ofs);
  fprintf (stderr, "\n");
#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.46
Committed:	Fri Jul 6 03:52:51 2007 UTC (16 years, 11 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.45:	+30 -11 lines
Log Message:	fix the fxix protocol mess and use some experimental sorting by size
#	User	Rev	Content
1	elmex	1.1	/*
2	root	1.44	* This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3	root	1.42	*
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	root	1.44	* 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	root	1.42	*
13	root	1.44	* 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	root	1.42	*
18	root	1.44	* 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	root	1.42	*
21			* The authors can be reached via e-mail to <crossfire@schmorp.de>
22	root	1.17	*/
23	elmex	1.1
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	root	1.20	#include "crc.h"
39
40	elmex	1.1	#define MAX_FACE_SETS 20 /*< Maximum number of image sets the program will handle /
41
42			/** Information about one image */
43	root	1.3	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	elmex	1.1	} FaceInfo;
49
50			/** Information about one face set */
51	root	1.3	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	elmex	1.1	} 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	root	1.3	int
71			is_valid_faceset (int fsn)
72	elmex	1.1	{
73	root	1.3	if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix)
74			return TRUE;
75			return FALSE;
76	elmex	1.1	}
77
78			/**
79			* Frees all faceset information
80			*/
81	root	1.3	void
82			free_socket_images (void)
83	elmex	1.1	{
84	root	1.3	int num, q;
85	elmex	1.1
86	root	1.3	for (num = 0; num < MAX_FACE_SETS; num++)
87			{
88			if (facesets[num].prefix)
89			{
90	root	1.24	for (q = 0; q < faces.size (); q++)
91	root	1.3	if (facesets[num].faces[q].data)
92			free (facesets[num].faces[q].data);
93	root	1.15
94	root	1.3	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	root	1.2	}
101	elmex	1.1	}
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	root	1.3	static int
117			get_face_fallback (int faceset, int imageno)
118	elmex	1.1	{
119	root	1.3	/* 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	root	1.15
134	root	1.3	if (facesets[faceset].faces[imageno].data)
135			return faceset;
136	root	1.15
137	root	1.3	return get_face_fallback (facesets[faceset].fallback, imageno);
138	elmex	1.1	}
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	root	1.3	static void
149			check_faceset_fallback (int faceset, int togo)
150	elmex	1.1	{
151	root	1.3	int fallback = facesets[faceset].fallback;
152	elmex	1.1
153	root	1.3	/* 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	root	1.15
163	root	1.3	togo--;
164			if (togo == 0)
165			{
166			LOG (llevError, "Infinite loop found in facesets. aborting.\n");
167			abort ();
168	elmex	1.1	}
169	root	1.15
170	root	1.3	check_faceset_fallback (fallback, togo);
171	elmex	1.1	}
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	root	1.3	void
181	root	1.13	SetFaceMode (char buf, int len, client ns)
182	elmex	1.1	{
183	root	1.3	int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
184	elmex	1.1
185	root	1.3	if (mode == CF_FACE_NONE)
186	root	1.7	ns->facecache = 1;
187	root	1.3	else if (mode != CF_FACE_PNG)
188	root	1.14	ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
189	root	1.7
190	root	1.3	if (mask)
191	root	1.7	ns->facecache = 1;
192	elmex	1.1	}
193
194			/**
195	root	1.43	* client requested an image. send it rate-limited
196			* before flushing.
197	elmex	1.1	*/
198	root	1.3	void
199	root	1.43	AskFaceCmd (char buf, int len, client ns)
200	elmex	1.1	{
201	root	1.43	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	root	1.46	auto (pos, ns->ixface.end ());
217
218			if (ns->fxix < 2)
219			{
220			// gcfclient does not support prioritising, older cfplus versions
221			// do not support interleaved transfers.
222			if (!ns->ixface.empty ())
223			pos = ns->ixface.end () - 1;
224			}
225			else
226			{
227			// the by far most common case will be to insert
228			// near the end, so little looping.
229			while (pos != ns->ixface.begin ())
230			{
231			--pos;
232
233			// sort within 2k bins, to slightly prefer smaller images
234			if (pri > pos->pri \|\| (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11)))
235			{
236			++pos;
237			break;
238			}
239			}
240			}
241
242			ns->ixface.insert (pos, ix);
243	root	1.45
244			#if 0
245	root	1.46	for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i)
246			fprintf (stderr, "<%d,%d> ", i->pri, i->ofs);
247			fprintf (stderr, "\n");
248	root	1.45	#endif
249	root	1.43	}
250
251			/**
252			* Tells client the picture it has to use
253			* to smooth a picture number given as argument.
254			*/
255			void
256			AskSmooth (char buf, int len, client ns)
257			{
258			ns->send_face (atoi (buf));
259			ns->flush_fx ();
260	elmex	1.1	}
261
262	root	1.24	// how lame
263			static void print_facename (packet &sl, const facedata &d)
264			{
265	root	1.25	for (int i = 0; i < CHKSUM_SIZE; ++i)
266			sl.printf ("%02x", d.chksum [i]);
267	root	1.24	}
268
269	root	1.32	// gcfclient uses the server-provided checksum for comparison, but always
270			// writes a broken checksum to its cache file, so we have to provide
271			// gcfclient with the same broken (and useless) checksum just to have it
272			// cache the image despite its bugs.
273	root	1.26	static uint32 gcfclient_checksum (const facedata *d)
274			{
275			uint32 csum = 0;
276
277			for (std::string::const_iterator i = d->data.begin ();
278			i != d->data.end ();
279			++i)
280			{
281			csum = rotate_right (csum);
282			csum += (uint8 )&*i;
283			}
284
285			return csum;
286			}
287
288	elmex	1.1	/**
289			* Sends a face to a client if they are in pixmap mode
290			* nothing gets sent in bitmap mode.
291			* If nocache is true (nonzero), ignore the cache setting from the client -
292			* this is needed for the askface, in which we really do want to send the
293			* face (and askface is the only place that should be setting it). Otherwise,
294			* we look at the facecache, and if set, send the image name.
295			*/
296	root	1.3	void
297	root	1.32	client::send_face (faceidx facenum)
298	elmex	1.1	{
299	root	1.28	// never send face 0. ever. it does not exist.
300			if (!facenum)
301			return;
302
303			const facedata *d = face_data (facenum, faceset);
304
305			if (!d)
306	root	1.3	{
307	root	1.28	LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum);
308	root	1.3	return;
309			}
310
311	root	1.32	if (faces_sent[facenum])
312			return;
313
314			faces_sent[facenum] = true;
315
316	root	1.38	// if for some reason we let a client without face caching connect,
317			// we better support that decision here and implement it.
318	root	1.33	if (!facecache)
319	root	1.38	return send_image (facenum);
320	root	1.33
321	root	1.39	if (fxix)
322			{
323			fxface.push_back (facenum);
324			return;
325			}
326
327	root	1.8	packet sl;
328	root	1.3
329	root	1.32	if (force_face0)
330			sl << "face " << uint16 (facenum);
331			else if (image2)
332			sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
333			else
334			sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
335
336			// how lame
337			print_facename (sl, *d);
338			send_packet (sl);
339
340	root	1.40	if (EMI_smooth)
341	root	1.3	{
342	root	1.40	faceinfo *f = face_info (facenum);
343	root	1.28
344	root	1.40	if (f->smooth)
345			{
346			send_face (f->smooth);
347
348			packet sl ("smooth");
349	root	1.30
350	root	1.40	sl << uint16 (facenum)
351			<< uint16 (f->smooth);
352	root	1.31
353	root	1.40	send_packet (sl);
354			}
355	root	1.32	}
356			}
357
358	root	1.39	void client::flush_fx ()
359			{
360			while (!fxface.empty ())
361			{
362	root	1.40	packet fx ("fx");
363			packet sx ("sx");
364	root	1.39
365			do
366			{
367			faceidx facenum = fxface.back (); fxface.pop_back ();
368
369			const facedata *d = face_data (facenum, faceset);
370
371			if (d)
372			{
373	root	1.40	fx << ber32 (facenum)
374	root	1.39	<< data8 (d->chksum, CHKSUM_SIZE);
375
376	root	1.40	if (smoothing)
377			{
378			faceinfo *f = face_info (facenum);
379
380			if (f->smooth)
381			{
382			send_face (f->smooth);
383			sx << ber32 (facenum)
384			<< ber32 (f->smooth)
385			<< ber32 (f->smoothlevel);
386			}
387			}
388	root	1.39	}
389			}
390	root	1.40	while (!fxface.empty ()
391			&& fx.room () > ber32::size + CHKSUM_SIZE + 1
392			&& sx.room () > ber32::size * 3);
393	root	1.39
394	root	1.40	send_packet (fx);
395			if (sx.length () > 3) send_packet (sx);
396	root	1.39	}
397			}
398
399	root	1.32	void
400			client::send_image (faceidx facenum)
401			{
402			// never send face 0. ever. it does not exist.
403			if (!facenum)
404			return;
405	root	1.31
406	root	1.32	const facedata *d = face_data (facenum, faceset);
407	root	1.30
408	root	1.43	faces_sent[facenum] = true;
409
410	root	1.32	if (!d)
411			{
412			LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
413			return;
414			}
415	root	1.43
416			//TODO: check type here?
417	root	1.34
418	root	1.36	if (force_image_newmap)
419			force_newmap = true;
420
421	root	1.32	packet sl;
422	root	1.30
423	root	1.32	sl << (image2 ? "image2 " : "image ")
424			<< uint32 (facenum);
425	root	1.6
426	root	1.32	if (image2)
427			sl << uint8 (0);
428	root	1.6
429	root	1.32	sl << uint32 (d->data.size ())
430			<< data (d->data.data (), d->data.size ());
431	root	1.31
432	root	1.32	send_packet (sl);
433	root	1.28	}
434
435			// send all faces of this object to the client
436			// this uses more bandwidth initially, but makes
437			// animations look much smoother, and every client
438			// is supposed to do client-side caching anyways.
439			void
440			client::send_faces (object *ob)
441			{
442			send_face (ob->face);
443
444			if (ob->animation_id)
445			{
446			animation &anim = animations [ob->animation_id];
447
448			for (int i = 0; i < anim.num_animations; i++)
449			send_face (anim.faces [i]);
450			}
451			}
452
453			/**
454			* Need to send an animation sequence to the client.
455			* We will send appropriate face commands to the client if we haven't
456			* sent them the face yet (this can become quite costly in terms of
457			* how much we are sending - on the other hand, this should only happen
458			* when the player logs in and picks stuff up.
459			*/
460			void
461			client::send_animation (short anim_num)
462			{
463			/* Do some checking on the anim_num we got. Note that the animations
464			* are added in contigous order, so if the number is in the valid
465			* range, it must be a valid animation.
466			*/
467	root	1.41	if (anim_num < 0 \|\| anim_num >= animations.size ())
468	root	1.28	{
469			LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
470			return;
471			}
472
473			packet sl ("anim");
474
475			sl << uint16 (anim_num)
476			<< uint16 (0); /* flags - not used right now */
477
478			/* Build up the list of faces. Also, send any information (ie, the
479			* the face itself) down to the client.
480			*/
481			for (int i = 0; i < animations[anim_num].num_animations; i++)
482			{
483			send_face (animations[anim_num].faces[i]);
484			sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */
485	elmex	1.1	}
486	root	1.6
487	root	1.28	send_packet (sl);
488
489			anims_sent[anim_num] = 1;
490	elmex	1.1	}
491
492			/**
493			* Sends the number of images, checksum of the face file,
494			* and the image_info file information. See the doc/Developers/protocol
495			* if you want further detail.
496			*/
497	root	1.3	void
498	root	1.15	send_image_info (client ns, char params)
499	elmex	1.1	{
500	root	1.8	packet sl;
501	elmex	1.1
502	root	1.24	//TODO: second parameter is a checksum, but it makes no sense in this current framework
503			sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
504	root	1.6
505	root	1.24	sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
506	elmex	1.1
507	root	1.11	ns->send_packet (sl);
508	elmex	1.1	}
509
510			/**
511			* Sends requested face information.
512			* \param ns socket to send to
513			* \param params contains first and last index of face
514			*
515			* For each image in [start..stop] sends
516			* - checksum
517			* - name
518			*/
519	root	1.3	void
520	root	1.15	send_image_sums (client ns, char params)
521	elmex	1.1	{
522	root	1.3	int start, stop;
523	pippijn	1.22	char *cp;
524	root	1.3
525	root	1.8	packet sl;
526	root	1.3
527			start = atoi (params);
528			for (cp = params; *cp != '\0'; cp++)
529			if (*cp == ' ')
530			break;
531
532			stop = atoi (cp);
533	root	1.24	if (stop < start \|\| *cp == '\0' \|\| (stop - start) > 1000 \|\| stop >= MAX_FACES)
534	root	1.3	{
535	root	1.7	sl.printf ("replyinfo image_sums %d %d", start, stop);
536			ns->send_packet (sl);
537			sl.reset ();
538	root	1.3	return;
539			}
540
541	root	1.6	sl.printf ("replyinfo image_sums %d %d ", start, stop);
542	root	1.3
543	root	1.24	for (int i = start; i <= stop && i < faces.size (); i++)
544	root	1.3	{
545	root	1.30	ns->faces_sent[i] = true;
546	root	1.3
547	root	1.24	const facedata *d = face_data (i, ns->faceset);
548	root	1.6
549	root	1.24	if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
550	root	1.23	break;
551
552	root	1.6	sl << uint16 (i)
553	root	1.24	<< uint32 (0) // checksum
554			<< uint8 (ns->faceset);
555
556			print_facename (sl, *d); sl << uint8 (0);
557	root	1.3	}
558	root	1.6
559	root	1.3	/* It would make more sense to catch this pre-emptively in the code above.
560			* however, if this really happens, we probably just want to cut down the
561			* size to less than 1000, since that is what we claim the protocol would
562			* support.
563			*/
564	root	1.23	//TODO: taken care of above, should simply abort or make sure the above code is correct
565	root	1.9	if (sl.length () >= MAXSOCKBUF)
566	root	1.3	{
567	root	1.9	LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
568	root	1.3	abort ();
569	elmex	1.1	}
570	root	1.6
571	root	1.11	ns->send_packet (sl);
572	elmex	1.1	}
573	root	1.6