ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/image.C
Revision: 1.15
Committed: Sat Dec 16 22:14:42 2006 UTC (17 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.14: +29 -21 lines
Log Message:
just reformats

File Contents

# Content
1 /*
2 CrossFire, A Multiplayer game for X-windows
3
4 Copyright (C) 2001 Mark Wedel
5 Copyright (C) 1992 Frank Tore Johansen
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
21 The author 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 #define MAX_FACE_SETS 20 /**< Maximum number of image sets the program will handle */
39
40 /** Information about one image */
41 typedef struct FaceInfo
42 {
43 uint8 *data; /**< image data */
44 uint16 datalen; /**< length of the xpm data */
45 uint32 checksum; /**< Checksum of face data */
46 } FaceInfo;
47
48 /** Information about one face set */
49 typedef struct
50 {
51 char *prefix; /**< */
52 char *fullname;
53
54 uint8 fallback; /**< faceset to use when an image is not found in this faceset */
55 char *size;
56 char *extension;
57 char *comment;
58
59 FaceInfo *faces; /**< images in this faceset */
60 } FaceSets;
61
62 static FaceSets facesets[MAX_FACE_SETS]; /**< All facesets */
63
64 /**
65 * Checks specified faceset is valid
66 * \param fsn faceset number
67 */
68 int
69 is_valid_faceset (int fsn)
70 {
71 if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix)
72 return TRUE;
73 return FALSE;
74 }
75
76 /**
77 * Frees all faceset information
78 */
79 void
80 free_socket_images (void)
81 {
82 int num, q;
83
84 for (num = 0; num < MAX_FACE_SETS; num++)
85 {
86 if (facesets[num].prefix)
87 {
88 for (q = 0; q < nrofpixmaps; q++)
89 if (facesets[num].faces[q].data)
90 free (facesets[num].faces[q].data);
91
92 free (facesets[num].prefix);
93 free (facesets[num].fullname);
94 free (facesets[num].size);
95 free (facesets[num].extension);
96 free (facesets[num].comment);
97 free (facesets[num].faces);
98 }
99 }
100 }
101
102 /**
103 * This returns the set we will actually use when sending
104 * a face. This is used because the image files may be sparse.
105 * This function is recursive. imageno is the face number we are
106 * trying to send
107 *
108 * If face is not found in specified faceset, tries with 'fallback' faceset.
109 *
110 * \param faceset faceset to check
111 * \param imageno image number
112 *
113 */
114 static int
115 get_face_fallback (int faceset, int imageno)
116 {
117 /* faceset 0 is supposed to have every image, so just return. Doing
118 * so also prevents infinite loops in the case if it not having
119 * the face, but in that case, we are likely to crash when we try
120 * to access the data, but that is probably preferable to an infinite
121 * loop.
122 */
123 if (faceset == 0)
124 return 0;
125
126 if (!facesets[faceset].prefix)
127 {
128 LOG (llevError, "get_face_fallback called with unused set (%d)?\n", faceset);
129 return 0; /* use default set */
130 }
131
132 if (facesets[faceset].faces[imageno].data)
133 return faceset;
134
135 return get_face_fallback (facesets[faceset].fallback, imageno);
136 }
137
138 /**
139 * Checks fallback are correctly defined.
140 * This is a simple recursive function that makes sure the fallbacks
141 * are all proper (eg, the fall back to defined sets, and also
142 * eventually fall back to 0). At the top level, togo is set to MAX_FACE_SETS,
143 * if togo gets to zero, it means we have a loop.
144 * This is only run when we first load the facesets.
145 */
146 static void
147 check_faceset_fallback (int faceset, int togo)
148 {
149 int fallback = facesets[faceset].fallback;
150
151 /* proper case - falls back to base set */
152 if (fallback == 0)
153 return;
154
155 if (!facesets[fallback].prefix)
156 {
157 LOG (llevError, "Face set %d falls to non set faceset %d\n", faceset, fallback);
158 abort ();
159 }
160
161 togo--;
162 if (togo == 0)
163 {
164 LOG (llevError, "Infinite loop found in facesets. aborting.\n");
165 abort ();
166 }
167
168 check_faceset_fallback (fallback, togo);
169 }
170
171 #define MAX_IMAGE_SIZE 10000
172
173 /**
174 * Loads all the image types into memory.
175 *
176 * This way, we can easily send them to the client. We should really do something
177 * better than abort on any errors - on the other hand, these are all fatal
178 * to the server (can't work around them), but the abort just seems a bit
179 * messy (exit would probably be better.)
180 *
181 * Couple of notes: We assume that the faces are in a continous block.
182 * This works fine for now, but this could perhaps change in the future
183 *
184 * Function largely rewritten May 2000 to be more general purpose.
185 * The server itself does not care what the image data is - to the server,
186 * it is just data it needs to allocate. As such, the code is written
187 * to do such.
188 */
189 void
190 read_client_images (void)
191 {
192 char filename[400];
193 char buf[HUGE_BUF];
194 char *cp, *cps[7];
195 FILE *infile;
196 int num, len, compressed, fileno, i, badline;
197
198 memset (facesets, 0, sizeof (facesets));
199 sprintf (filename, "%s/image_info", settings.datadir);
200 if ((infile = open_and_uncompress (filename, 0, &compressed)) == NULL)
201 {
202 LOG (llevError, "Unable to open %s\n", filename);
203 abort ();
204 }
205
206 while (fgets (buf, HUGE_BUF - 1, infile) != NULL)
207 {
208 badline = 0;
209
210 if (buf[0] == '#')
211 continue;
212
213 if (!(cps[0] = strtok (buf, ":")))
214 badline = 1;
215
216 for (i = 1; i < 7; i++)
217 if (!(cps[i] = strtok (NULL, ":")))
218 badline = 1;
219
220 if (badline)
221 LOG (llevError, "Bad line in image_info file, ignoring line:\n %s", buf);
222 else
223 {
224 len = atoi (cps[0]);
225 if (len >= MAX_FACE_SETS)
226 {
227 LOG (llevError, "To high a setnum in image_info file: %d > %d\n", len, MAX_FACE_SETS);
228 abort ();
229 }
230 facesets[len].prefix = strdup (cps[1]);
231 facesets[len].fullname = strdup (cps[2]);
232 facesets[len].fallback = atoi (cps[3]);
233 facesets[len].size = strdup (cps[4]);
234 facesets[len].extension = strdup (cps[5]);
235 facesets[len].comment = strdup (cps[6]);
236 }
237 }
238
239 close_and_delete (infile, compressed);
240
241 for (i = 0; i < MAX_FACE_SETS; i++)
242 {
243 if (facesets[i].prefix)
244 check_faceset_fallback (i, MAX_FACE_SETS);
245 }
246
247 /* Loaded the faceset information - now need to load up the
248 * actual faces.
249 */
250
251 for (fileno = 0; fileno < MAX_FACE_SETS; fileno++)
252 {
253 /* if prefix is not set, this is not used */
254 if (!facesets[fileno].prefix)
255 continue;
256
257 facesets[fileno].faces = (FaceInfo *) calloc (nrofpixmaps, sizeof (FaceInfo));
258
259 sprintf (filename, "%s/crossfire.%d", settings.datadir, fileno);
260 LOG (llevDebug, "Loading image file %s\n", filename);
261
262 if ((infile = open_and_uncompress (filename, 0, &compressed)) == NULL)
263 {
264 LOG (llevError, "Unable to open %s\n", filename);
265 abort ();
266 }
267
268 while (fgets (buf, HUGE_BUF - 1, infile) != NULL)
269 {
270 if (strncmp (buf, "IMAGE ", 6) != 0)
271 {
272 LOG (llevError, "read_client_images:Bad image line - not IMAGE, instead\n%s", buf);
273 abort ();
274 }
275
276 num = atoi (buf + 6);
277 if (num < 0 || num >= nrofpixmaps)
278 {
279 LOG (llevError, "read_client_images: Image num %d not in 0..%d\n%s", num, nrofpixmaps, buf);
280 abort ();
281 }
282
283 /* Skip accross the number data */
284 for (cp = buf + 6; *cp != ' '; cp++);
285 len = atoi (cp);
286 if (len == 0 || len > MAX_IMAGE_SIZE)
287 {
288 LOG (llevError, "read_client_images: length not valid: %d > %d \n%s", len, MAX_IMAGE_SIZE, buf);
289 abort ();
290 }
291
292 /* We don't actualy care about the name of the image that
293 * is embedded in the image file, so just ignore it.
294 */
295 facesets[fileno].faces[num].datalen = len;
296 facesets[fileno].faces[num].data = (uint8 *) malloc (len);
297 if ((i = fread (facesets[fileno].faces[num].data, len, 1, infile)) != 1)
298 {
299 LOG (llevError, "read_client_images: Did not read desired amount of data, wanted %d, got %d\n%s", len, i, buf);
300 abort ();
301 }
302
303 facesets[fileno].faces[num].checksum = 0;
304 for (i = 0; i < len; i++)
305 {
306 ROTATE_RIGHT (facesets[fileno].faces[num].checksum);
307 facesets[fileno].faces[num].checksum += facesets[fileno].faces[num].data[i];
308 facesets[fileno].faces[num].checksum &= 0xffffffff;
309 }
310 }
311
312 close_and_delete (infile, compressed);
313 } /* For fileno < MAX_FACE_SETS */
314 }
315
316 /**
317 * Client tells us what type of faces it wants. Also sets
318 * the caching attribute.
319 *
320 */
321 void
322 SetFaceMode (char *buf, int len, client *ns)
323 {
324 int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE);
325
326 if (mode == CF_FACE_NONE)
327 ns->facecache = 1;
328 else if (mode != CF_FACE_PNG)
329 ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png");
330
331 if (mask)
332 ns->facecache = 1;
333 }
334
335 /**
336 * Client has requested pixmap that it somehow missed getting.
337 * This will be called often if the client is
338 * caching images.
339 */
340 void
341 SendFaceCmd (char *buf, int len, client *ns)
342 {
343 uint16 facenum = atoi (buf);
344
345 if (facenum != 0)
346 esrv_send_face (ns, facenum, 1);
347 }
348
349 /**
350 * Sends a face to a client if they are in pixmap mode
351 * nothing gets sent in bitmap mode.
352 * If nocache is true (nonzero), ignore the cache setting from the client -
353 * this is needed for the askface, in which we really do want to send the
354 * face (and askface is the only place that should be setting it). Otherwise,
355 * we look at the facecache, and if set, send the image name.
356 */
357 void
358 esrv_send_face (client *ns, short face_num, int nocache)
359 {
360 char fallback;
361
362 if (face_num <= 0 || face_num >= nrofpixmaps)
363 {
364 LOG (llevError, "esrv_send_face (%d) out of bounds??\n", face_num);
365 return;
366 }
367
368 packet sl;
369 fallback = get_face_fallback (ns->faceset, face_num);
370
371 if (facesets[fallback].faces[face_num].data == NULL)
372 {
373 LOG (llevError, "esrv_send_face: faces[%d].data == NULL\n", face_num);
374 return;
375 }
376
377 if (ns->facecache && !nocache)
378 {
379 sl << (ns->image2 ? "face2 " : "face1 ")
380 << uint16 (face_num);
381
382 if (ns->image2)
383 sl << uint8 (fallback);
384
385 sl << uint32 (facesets[fallback].faces[face_num].checksum)
386 << new_faces[face_num].name;
387
388 ns->send_packet (sl);
389 }
390 else
391 {
392 sl << (ns->image2 ? "image2 " : "image ")
393 << uint32 (face_num);
394
395 if (ns->image2)
396 sl << uint8 (fallback);
397
398 sl << uint32 (facesets[fallback].faces[face_num].datalen)
399 << data (facesets[fallback].faces[face_num].data, facesets[fallback].faces[face_num].datalen);
400
401 ns->send_packet (sl);
402 }
403
404 ns->faces_sent[face_num] |= NS_FACESENT_FACE;
405 }
406
407 /**
408 * Sends the number of images, checksum of the face file,
409 * and the image_info file information. See the doc/Developers/protocol
410 * if you want further detail.
411 */
412
413 void
414 send_image_info (client *ns, char *params)
415 {
416 packet sl;
417
418 sl.printf ("replyinfo image_info\n%d\n%d\n", nrofpixmaps - 1, bmaps_checksum);
419
420 for (int i = 0; i < MAX_FACE_SETS; i++)
421 if (facesets[i].prefix)
422 sl.printf ("%d:%s:%s:%d:%s:%s:%s", i,
423 facesets[i].prefix, facesets[i].fullname , facesets[i].fallback,
424 facesets[i].size , facesets[i].extension, facesets[i].comment);
425
426 ns->send_packet (sl);
427 }
428
429 /**
430 * Sends requested face information.
431 * \param ns socket to send to
432 * \param params contains first and last index of face
433 *
434 * For each image in [start..stop] sends
435 * - checksum
436 * - name
437 */
438 void
439 send_image_sums (client *ns, char *params)
440 {
441 int start, stop;
442 char *cp, buf[MAX_BUF];
443
444 packet sl;
445
446 start = atoi (params);
447 for (cp = params; *cp != '\0'; cp++)
448 if (*cp == ' ')
449 break;
450
451 stop = atoi (cp);
452 if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= nrofpixmaps)
453 {
454 sl.printf ("replyinfo image_sums %d %d", start, stop);
455 ns->send_packet (sl);
456 sl.reset ();
457 return;
458 }
459
460 sl.printf ("replyinfo image_sums %d %d ", start, stop);
461
462 for (int i = start; i <= stop; i++)
463 {
464 ns->faces_sent[i] |= NS_FACESENT_FACE;
465
466 int qq = get_face_fallback (ns->faceset, i);
467
468 sl << uint16 (i)
469 << uint32 (facesets[qq].faces[i].checksum)
470 << uint8 (qq)
471 << data8 (&new_faces[i].name, new_faces[i].name.length () + 1);
472 }
473
474 /* It would make more sense to catch this pre-emptively in the code above.
475 * however, if this really happens, we probably just want to cut down the
476 * size to less than 1000, since that is what we claim the protocol would
477 * support.
478 */
479 if (sl.length () >= MAXSOCKBUF)
480 {
481 LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF);
482 abort ();
483 }
484
485 ns->send_packet (sl);
486 }
487