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

  //TODO: somehow fetch default priority from send_fx here

  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), -100);
  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, int pri)
{
  // never send face 0. ever. it does not exist.
  if (!facenum)
    return;

  faceinfo *f = face_info (facenum);

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

  // refuse to send non-image faces
  if (!fx_want [f->type])
    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;
    }

  const facedata *d = f->data (faceset);

  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)
    {
      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");
      int type = 0;

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

          if (const faceinfo *f = face_info (facenum))
            {
              if (f->type != type)
                {
                  type = f->type;

                  fx << ber32 (0)
                     << uint8 (1) << uint8 (type);
                }

              const facedata *d = f->data (faceset);

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

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

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

                      sx << ber32 (facenum)
                         << ber32 (f->smooth)
                         << ber32 (f->smoothlevel);
                    }
                }
            }
        }
      while (!fxface.empty ()
             && fx.room () > ber32::size + CHKSUM_SIZE + 1 + 3 /* type switch */
             && 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;
    }
  
  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, 10);

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

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

/**
 * 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], -20);
      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.51
Committed:	Tue Jul 24 04:58:25 2007 UTC (16 years, 10 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.50:	+2 -2 lines
Log Message:	welcome to fxix protocol version 3, with uniform handling over all resources
#	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_IMAGE_SIZE 10000
41
42	/**
43	* Client tells us what type of faces it wants. Also sets
44	* the caching attribute.
45	*
46	*/
47	void
48	SetFaceMode (char buf, int len, client ns)
49	{
50	int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
51
52	if (mode == CF_FACE_NONE)
53	ns->facecache = 1;
54	else if (mode != CF_FACE_PNG)
55	ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
56
57	if (mask)
58	ns->facecache = 1;
59	}
60
61	/**
62	* client requested an image. send it rate-limited
63	* before flushing.
64	*/
65	void
66	AskFaceCmd (char buf, int len, client ns)
67	{
68	int idx = 0, pri = 0;
69
70	sscanf (buf, "%d %d", &idx, &pri);
71
72	//TODO: somehow fetch default priority from send_fx here
73
74	const facedata *d = face_data (idx, ns->faceset);
75
76	if (!d)
77	return; // doh
78
79	client::ixsend ix;
80
81	ix.pri = pri;
82	ix.idx = idx;
83	ix.ofs = d->data.size ();
84
85	auto (pos, ns->ixface.end ());
86
87	if (ns->fxix < 2)
88	{
89	// gcfclient does not support prioritising, older cfplus versions
90	// do not support interleaved transfers.
91	if (!ns->ixface.empty ())
92	pos = ns->ixface.end () - 1;
93	}
94	else
95	{
96	// the by far most common case will be to insert
97	// near the end, so little looping.
98	while (pos != ns->ixface.begin ())
99	{
100	--pos;
101
102	// sort within 2k bins, to slightly prefer smaller images
103	if (pri > pos->pri \|\| (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11)))
104	{
105	++pos;
106	break;
107	}
108	}
109	}
110
111	ns->ixface.insert (pos, ix);
112
113	#if 0
114	for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i)
115	fprintf (stderr, "<%d,%d> ", i->pri, i->ofs);
116	fprintf (stderr, "\n");
117	#endif
118	}
119
120	/**
121	* Tells client the picture it has to use
122	* to smooth a picture number given as argument.
123	*/
124	void
125	AskSmooth (char buf, int len, client ns)
126	{
127	ns->send_face (atoi (buf), -100);
128	ns->flush_fx ();
129	}
130
131	// how lame
132	static void print_facename (packet &sl, const facedata &d)
133	{
134	for (int i = 0; i < CHKSUM_SIZE; ++i)
135	sl.printf ("%02x", d.chksum [i]);
136	}
137
138	// gcfclient uses the server-provided checksum for comparison, but always
139	// writes a broken checksum to its cache file, so we have to provide
140	// gcfclient with the same broken (and useless) checksum just to have it
141	// cache the image despite its bugs.
142	static uint32 gcfclient_checksum (const facedata *d)
143	{
144	uint32 csum = 0;
145
146	for (std::string::const_iterator i = d->data.begin ();
147	i != d->data.end ();
148	++i)
149	{
150	csum = rotate_right (csum);
151	csum += (uint8 )&*i;
152	}
153
154	return csum;
155	}
156
157	/**
158	* Sends a face to a client if they are in pixmap mode
159	* nothing gets sent in bitmap mode.
160	* If nocache is true (nonzero), ignore the cache setting from the client -
161	* this is needed for the askface, in which we really do want to send the
162	* face (and askface is the only place that should be setting it). Otherwise,
163	* we look at the facecache, and if set, send the image name.
164	*/
165	void
166	client::send_face (faceidx facenum, int pri)
167	{
168	// never send face 0. ever. it does not exist.
169	if (!facenum)
170	return;
171
172	faceinfo *f = face_info (facenum);
173
174	if (!f)
175	{
176	LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum);
177	return;
178	}
179
180	// refuse to send non-image faces
181	if (!fx_want [f->type])
182	return;
183
184	if (faces_sent [facenum])
185	return;
186
187	faces_sent[facenum] = true;
188
189	// if for some reason we let a client without face caching connect,
190	// we better support that decision here and implement it.
191	if (!facecache)
192	return send_image (facenum);
193
194	if (fxix)
195	{
196	fxface.push_back (facenum);
197	return;
198	}
199
200	const facedata *d = f->data (faceset);
201
202	packet sl;
203
204	if (force_face0)
205	sl << "face " << uint16 (facenum);
206	else if (image2)
207	sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
208	else
209	sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
210
211	// how lame
212	print_facename (sl, *d);
213	send_packet (sl);
214
215	if (EMI_smooth)
216	{
217	if (f->smooth)
218	{
219	send_face (f->smooth);
220
221	packet sl ("smooth");
222
223	sl << uint16 (facenum)
224	<< uint16 (f->smooth);
225
226	send_packet (sl);
227	}
228	}
229	}
230
231	void client::flush_fx ()
232	{
233	while (!fxface.empty ())
234	{
235	packet fx ("fx");
236	packet sx ("sx");
237	int type = 0;
238
239	do
240	{
241	faceidx facenum = fxface.back (); fxface.pop_back ();
242
243	if (const faceinfo *f = face_info (facenum))
244	{
245	if (f->type != type)
246	{
247	type = f->type;
248
249	fx << ber32 (0)
250	<< uint8 (1) << uint8 (type);
251	}
252
253	const facedata *d = f->data (faceset);
254
255	fx << ber32 (facenum)
256	<< data8 (d->chksum, CHKSUM_SIZE);
257
258	if (smoothing)
259	{
260	faceinfo *f = face_info (facenum);
261
262	if (f->smooth)
263	{
264	send_face (f->smooth, -110);
265
266	sx << ber32 (facenum)
267	<< ber32 (f->smooth)
268	<< ber32 (f->smoothlevel);
269	}
270	}
271	}
272	}
273	while (!fxface.empty ()
274	&& fx.room () > ber32::size + CHKSUM_SIZE + 1 + 3 /* type switch */
275	&& sx.room () > ber32::size * 3);
276
277	send_packet (fx);
278	if (sx.length () > 3) send_packet (sx);
279	}
280	}
281
282	void
283	client::send_image (faceidx facenum)
284	{
285	// never send face 0. ever. it does not exist.
286	if (!facenum)
287	return;
288
289	const facedata *d = face_data (facenum, faceset);
290
291	faces_sent[facenum] = true;
292
293	if (!d)
294	{
295	LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
296	return;
297	}
298
299	if (force_image_newmap)
300	force_newmap = true;
301
302	packet sl;
303
304	sl << (image2 ? "image2 " : "image ")
305	<< uint32 (facenum);
306
307	if (image2)
308	sl << uint8 (0);
309
310	sl << uint32 (d->data.size ())
311	<< data (d->data.data (), d->data.size ());
312
313	send_packet (sl);
314	}
315
316	// send all faces of this object to the client
317	// this uses more bandwidth initially, but makes
318	// animations look much smoother, and every client
319	// is supposed to do client-side caching anyways.
320	void
321	client::send_faces (object *ob)
322	{
323	send_face (ob->face, 10);
324
325	if (ob->animation_id)
326	{
327	animation &anim = animations [ob->animation_id];
328
329	for (int i = 0; i < anim.num_animations; i++)
330	send_face (anim.faces [i], -10);
331	}
332	}
333
334	/**
335	* Need to send an animation sequence to the client.
336	* We will send appropriate face commands to the client if we haven't
337	* sent them the face yet (this can become quite costly in terms of
338	* how much we are sending - on the other hand, this should only happen
339	* when the player logs in and picks stuff up.
340	*/
341	void
342	client::send_animation (short anim_num)
343	{
344	/* Do some checking on the anim_num we got. Note that the animations
345	* are added in contigous order, so if the number is in the valid
346	* range, it must be a valid animation.
347	*/
348	if (anim_num < 0 \|\| anim_num >= animations.size ())
349	{
350	LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
351	return;
352	}
353
354	packet sl ("anim");
355
356	sl << uint16 (anim_num)
357	<< uint16 (0); /* flags - not used right now */
358
359	/* Build up the list of faces. Also, send any information (ie, the
360	* the face itself) down to the client.
361	*/
362	for (int i = 0; i < animations[anim_num].num_animations; i++)
363	{
364	send_face (animations[anim_num].faces[i], -20);
365	sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */
366	}
367
368	send_packet (sl);
369
370	anims_sent[anim_num] = 1;
371	}
372
373	/**
374	* Sends the number of images, checksum of the face file,
375	* and the image_info file information. See the doc/Developers/protocol
376	* if you want further detail.
377	*/
378	void
379	send_image_info (client ns, char params)
380	{
381	packet sl;
382
383	//TODO: second parameter is a checksum, but it makes no sense in this current framework
384	sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
385
386	sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
387
388	ns->send_packet (sl);
389	}
390
391	/**
392	* Sends requested face information.
393	* \param ns socket to send to
394	* \param params contains first and last index of face
395	*
396	* For each image in [start..stop] sends
397	* - checksum
398	* - name
399	*/
400	void
401	send_image_sums (client ns, char params)
402	{
403	int start, stop;
404	char *cp;
405
406	packet sl;
407
408	start = atoi (params);
409	for (cp = params; *cp != '\0'; cp++)
410	if (*cp == ' ')
411	break;
412
413	stop = atoi (cp);
414	if (stop < start \|\| *cp == '\0' \|\| (stop - start) > 1000 \|\| stop >= MAX_FACES)
415	{
416	sl.printf ("replyinfo image_sums %d %d", start, stop);
417	ns->send_packet (sl);
418	sl.reset ();
419	return;
420	}
421
422	sl.printf ("replyinfo image_sums %d %d ", start, stop);
423
424	for (int i = start; i <= stop && i < faces.size (); i++)
425	{
426	ns->faces_sent[i] = true;
427
428	const facedata *d = face_data (i, ns->faceset);
429
430	if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
431	break;
432
433	sl << uint16 (i)
434	<< uint32 (0) // checksum
435	<< uint8 (ns->faceset);
436
437	print_facename (sl, *d); sl << uint8 (0);
438	}
439
440	/* It would make more sense to catch this pre-emptively in the code above.
441	* however, if this really happens, we probably just want to cut down the
442	* size to less than 1000, since that is what we claim the protocol would
443	* support.
444	*/
445	//TODO: taken care of above, should simply abort or make sure the above code is correct
446	if (sl.length () >= MAXSOCKBUF)
447	{
448	LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
449	abort ();
450	}
451
452	ns->send_packet (sl);
453	}
454