ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/image.C
Revision: 1.4
Committed: Thu Sep 14 22:34:05 2006 UTC (17 years, 8 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.3: +1 -7 lines
Log Message:
indent

File Contents

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