ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/image.C
Revision: 1.32
Committed: Wed Mar 14 15:44:47 2007 UTC (17 years, 2 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.31: +60 -38 lines
Log Message:
- make face caching mandatory, and pester users to enable it
- implement rate-limiting, for images only right now
- implement and document output-rate command to set rate limit.
- default 1mbit.

File Contents

# 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 ns->send_image (atoi (buf));
204 }
205
206 // how lame
207 static void print_facename (packet &sl, const facedata &d)
208 {
209 for (int i = 0; i < CHKSUM_SIZE; ++i)
210 sl.printf ("%02x", d.chksum [i]);
211 }
212
213 // gcfclient uses the server-provided checksum for comparison, but always
214 // writes a broken checksum to its cache file, so we have to provide
215 // gcfclient with the same broken (and useless) checksum just to have it
216 // cache the image despite its bugs.
217 static uint32 gcfclient_checksum (const facedata *d)
218 {
219 uint32 csum = 0;
220
221 for (std::string::const_iterator i = d->data.begin ();
222 i != d->data.end ();
223 ++i)
224 {
225 csum = rotate_right (csum);
226 csum += *(uint8 *)&*i;
227 }
228
229 return csum;
230 }
231
232 /**
233 * Sends a face to a client if they are in pixmap mode
234 * nothing gets sent in bitmap mode.
235 * If nocache is true (nonzero), ignore the cache setting from the client -
236 * this is needed for the askface, in which we really do want to send the
237 * face (and askface is the only place that should be setting it). Otherwise,
238 * we look at the facecache, and if set, send the image name.
239 */
240 void
241 client::send_face (faceidx facenum)
242 {
243 if (!facecache)
244 {
245 send_drawinfo (
246 "*** Please enable face caching or use a client that supports it.\n",
247 NDI_RED
248 );
249 return send_image (facenum);
250 }
251
252 // never send face 0. ever. it does not exist.
253 if (!facenum)
254 return;
255
256 const facedata *d = face_data (facenum, faceset);
257
258 if (!d)
259 {
260 LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum);
261 return;
262 }
263
264 if (faces_sent[facenum])
265 return;
266
267 faces_sent[facenum] = true;
268
269 packet sl;
270
271 if (force_face0)
272 sl << "face " << uint16 (facenum);
273 else if (image2)
274 sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
275 else
276 sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0);
277
278 // how lame
279 print_facename (sl, *d);
280 send_packet (sl);
281
282 faceinfo *f = face_info (facenum);
283 if (f->smooth && EMI_smooth)
284 {
285 send_face (f->smooth);
286
287 packet sl ("smooth");
288
289 sl << uint16 (facenum)
290 << uint16 (f->smooth);
291
292 send_packet (sl);
293 }
294 }
295
296 void
297 client::send_image (faceidx facenum)
298 {
299 // 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 {
307 LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum);
308 return;
309 }
310
311 packet sl;
312
313 sl << (image2 ? "image2 " : "image ")
314 << uint32 (facenum);
315
316 if (image2)
317 sl << uint8 (0);
318
319 sl << uint32 (d->data.size ())
320 << data (d->data.data (), d->data.size ());
321
322 send_packet (sl);
323 }
324
325 // send all faces of this object to the client
326 // this uses more bandwidth initially, but makes
327 // animations look much smoother, and every client
328 // is supposed to do client-side caching anyways.
329 void
330 client::send_faces (object *ob)
331 {
332 send_face (ob->face);
333
334 if (ob->animation_id)
335 {
336 animation &anim = animations [ob->animation_id];
337
338 for (int i = 0; i < anim.num_animations; i++)
339 send_face (anim.faces [i]);
340 }
341 }
342
343 /**
344 * Need to send an animation sequence to the client.
345 * We will send appropriate face commands to the client if we haven't
346 * sent them the face yet (this can become quite costly in terms of
347 * how much we are sending - on the other hand, this should only happen
348 * when the player logs in and picks stuff up.
349 */
350 void
351 client::send_animation (short anim_num)
352 {
353 /* Do some checking on the anim_num we got. Note that the animations
354 * are added in contigous order, so if the number is in the valid
355 * range, it must be a valid animation.
356 */
357 if (anim_num < 0 || anim_num > num_animations)
358 {
359 LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num);
360 return;
361 }
362
363 packet sl ("anim");
364
365 sl << uint16 (anim_num)
366 << uint16 (0); /* flags - not used right now */
367
368 /* Build up the list of faces. Also, send any information (ie, the
369 * the face itself) down to the client.
370 */
371 for (int i = 0; i < animations[anim_num].num_animations; i++)
372 {
373 send_face (animations[anim_num].faces[i]);
374 sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */
375 }
376
377 send_packet (sl);
378
379 anims_sent[anim_num] = 1;
380 }
381
382 /**
383 * Sends the number of images, checksum of the face file,
384 * and the image_info file information. See the doc/Developers/protocol
385 * if you want further detail.
386 */
387 void
388 send_image_info (client *ns, char *params)
389 {
390 packet sl;
391
392 //TODO: second parameter is a checksum, but it makes no sense in this current framework
393 sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0);
394
395 sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n";
396
397 ns->send_packet (sl);
398 }
399
400 /**
401 * Sends requested face information.
402 * \param ns socket to send to
403 * \param params contains first and last index of face
404 *
405 * For each image in [start..stop] sends
406 * - checksum
407 * - name
408 */
409 void
410 send_image_sums (client *ns, char *params)
411 {
412 int start, stop;
413 char *cp;
414
415 packet sl;
416
417 start = atoi (params);
418 for (cp = params; *cp != '\0'; cp++)
419 if (*cp == ' ')
420 break;
421
422 stop = atoi (cp);
423 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES)
424 {
425 sl.printf ("replyinfo image_sums %d %d", start, stop);
426 ns->send_packet (sl);
427 sl.reset ();
428 return;
429 }
430
431 sl.printf ("replyinfo image_sums %d %d ", start, stop);
432
433 for (int i = start; i <= stop && i < faces.size (); i++)
434 {
435 ns->faces_sent[i] = true;
436
437 const facedata *d = face_data (i, ns->faceset);
438
439 if (sl.room () < 2 + 4 + 1 + d->data.size () + 1)
440 break;
441
442 sl << uint16 (i)
443 << uint32 (0) // checksum
444 << uint8 (ns->faceset);
445
446 print_facename (sl, *d); sl << uint8 (0);
447 }
448
449 /* It would make more sense to catch this pre-emptively in the code above.
450 * however, if this really happens, we probably just want to cut down the
451 * size to less than 1000, since that is what we claim the protocol would
452 * support.
453 */
454 //TODO: taken care of above, should simply abort or make sure the above code is correct
455 if (sl.length () >= MAXSOCKBUF)
456 {
457 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
458 abort ();
459 }
460
461 ns->send_packet (sl);
462 }
463