server/socket/image.C

/*
 * CrossFire, A Multiplayer game
 *
 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
 * Copyright (C) 2001 Mark Wedel
 * 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
 * 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 has requested pixmap that it somehow missed getting.
 * This will be called often if the client is
 * caching images.
 */
void
SendFaceCmd (char *buf, int len, client *ns)
{
  uint16 facenum = atoi (buf);

  if (facenum != 0)
    esrv_send_face (ns, facenum, 1);
}

// 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 wrotes a broken checksum to its cache file, so we
// have to provide gcfclient with a useless checksum just to
// have to 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
esrv_send_face (client *ns, short face_num, int nocache)
{
  if (face_num <= 0 || face_num >= faces.size ())
    {
      LOG (llevError, "esrv_send_face (%d) out of bounds??\n", face_num);
      return;
    }

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

  packet sl;

  if (ns->facecache && !nocache)
    {
      if (ns->force_face0)
        sl << "face " << uint16 (face_num);
      else if (ns->image2)
        sl << "face2 " << uint16 (face_num) << uint8 (0) << uint32 (ns->force_bad_checksum ? gcfclient_checksum (d) : 0);
      else
        sl << "face1 " << uint16 (face_num) << uint32 (ns->force_bad_checksum ? gcfclient_checksum (d) : 0);

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

      ns->send_packet (sl);
    }
  else
    {
      fprintf (stderr, "image %s %d\n", &faces [face_num].name, nocache);//D
      sl << (ns->image2 ? "image2 " : "image ")
         << uint32 (face_num);

      if (ns->image2)
        sl << uint8 (0);

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

      ns->send_packet (sl);
    }

  ns->faces_sent[face_num] |= NS_FACESENT_FACE;
}

/**
 * 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] |= NS_FACESENT_FACE;

      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.26
Committed:	Mon Mar 12 23:45:10 2007 UTC (17 years, 3 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.25:	+26 -7 lines
Log Message:	- gcfclient compares against the server-provided image checksum but stores its own checksum in the database. needless to say, they differed. needless to say, we now have to provide a dummy superfluous gcfclient checksum for gcfclient only. - add various bug workaround flags to enbale gcfclient to cache imges again.
#	Content
1	/*
2	* CrossFire, A Multiplayer game
3	*
4	* Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5	* Copyright (C) 2001 Mark Wedel
6	* Copyright (C) 1992 Frank Tore Johansen
7	*
8	* This program 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 2 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, write to the Free Software
20	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21	*
22	* The author 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 has requested pixmap that it somehow missed getting.
197	* This will be called often if the client is
198	* caching images.
199	*/
200	void
201	SendFaceCmd (char buf, int len, client ns)
202	{
203	uint16 facenum = atoi (buf);
204
205	if (facenum != 0)
206	esrv_send_face (ns, facenum, 1);
207	}
208
209	// how lame
210	static void print_facename (packet &sl, const facedata &d)
211	{
212	for (int i = 0; i < CHKSUM_SIZE; ++i)
213	sl.printf ("%02x", d.chksum [i]);
214	}
215
216	// gcfclient uses the server-provided checksum for comparison,
217	// but always wrotes a broken checksum to its cache file, so we
218	// have to provide gcfclient with a useless checksum just to
219	// have to cache the image despite its bugs.
220	static uint32 gcfclient_checksum (const facedata *d)
221	{
222	uint32 csum = 0;
223
224	for (std::string::const_iterator i = d->data.begin ();
225	i != d->data.end ();
226	++i)
227	{
228	csum = rotate_right (csum);
229	csum += (uint8 )&*i;
230	}
231
232	return csum;
233	}
234
235	/**
236	* Sends a face to a client if they are in pixmap mode
237	* nothing gets sent in bitmap mode.
238	* If nocache is true (nonzero), ignore the cache setting from the client -
239	* this is needed for the askface, in which we really do want to send the
240	* face (and askface is the only place that should be setting it). Otherwise,
241	* we look at the facecache, and if set, send the image name.
242	*/
243	void
244	esrv_send_face (client *ns, short face_num, int nocache)
245	{
246	if (face_num <= 0 \|\| face_num >= faces.size ())
247	{
248	LOG (llevError, "esrv_send_face (%d) out of bounds??\n", face_num);
249	return;
250	}
251
252	const facedata *d = face_data (face_num, ns->faceset);
253
254	packet sl;
255
256	if (ns->facecache && !nocache)
257	{
258	if (ns->force_face0)
259	sl << "face " << uint16 (face_num);
260	else if (ns->image2)
261	sl << "face2 " << uint16 (face_num) << uint8 (0) << uint32 (ns->force_bad_checksum ? gcfclient_checksum (d) : 0);
262	else
263	sl << "face1 " << uint16 (face_num) << uint32 (ns->force_bad_checksum ? gcfclient_checksum (d) : 0);
264
265	// how lame
266	print_facename (sl, *d);
267
268	ns->send_packet (sl);
269	}
270	else
271	{
272	fprintf (stderr, "image %s %d\n", &faces [face_num].name, nocache);//D
273	sl << (ns->image2 ? "image2 " : "image ")
274	<< uint32 (face_num);
275
276	if (ns->image2)
277	sl << uint8 (0);
278
279	sl << uint32 (d->data.size ())
280	<< data (d->data.data (), d->data.size ());
281
282	ns->send_packet (sl);
283	}
284
285	ns->faces_sent[face_num] \|= NS_FACESENT_FACE;
286	}
287
288	/**
289	* Sends the number of images, checksum of the face file,
290	* and the image_info file information. See the doc/Developers/protocol
291	* if you want further detail.
292	*/
293
294	void
295	send_image_info (client ns, char params)
296	{
297	packet sl;
298
299	//TODO: second parameter is a checksum, but it makes no sense in this current framework
300	sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
301
302	sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
303
304	ns->send_packet (sl);
305	}
306
307	/**
308	* Sends requested face information.
309	* \param ns socket to send to
310	* \param params contains first and last index of face
311	*
312	* For each image in [start..stop] sends
313	* - checksum
314	* - name
315	*/
316	void
317	send_image_sums (client ns, char params)
318	{
319	int start, stop;
320	char *cp;
321
322	packet sl;
323
324	start = atoi (params);
325	for (cp = params; *cp != '\0'; cp++)
326	if (*cp == ' ')
327	break;
328
329	stop = atoi (cp);
330	if (stop < start \|\| *cp == '\0' \|\| (stop - start) > 1000 \|\| stop >= MAX_FACES)
331	{
332	sl.printf ("replyinfo image_sums %d %d", start, stop);
333	ns->send_packet (sl);
334	sl.reset ();
335	return;
336	}
337
338	sl.printf ("replyinfo image_sums %d %d ", start, stop);
339
340	for (int i = start; i <= stop && i < faces.size (); i++)
341	{
342	ns->faces_sent[i] \|= NS_FACESENT_FACE;
343
344	const facedata *d = face_data (i, ns->faceset);
345
346	if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
347	break;
348
349	sl << uint16 (i)
350	<< uint32 (0) // checksum
351	<< uint8 (ns->faceset);
352
353	print_facename (sl, *d); sl << uint8 (0);
354	}
355
356	/* It would make more sense to catch this pre-emptively in the code above.
357	* however, if this really happens, we probably just want to cut down the
358	* size to less than 1000, since that is what we claim the protocol would
359	* support.
360	*/
361	//TODO: taken care of above, should simply abort or make sure the above code is correct
362	if (sl.length () >= MAXSOCKBUF)
363	{
364	LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
365	abort ();
366	}
367
368	ns->send_packet (sl);
369	}
370