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 |
sl.printf ("%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x" |
213 |
"%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x", |
214 |
d.chksum [ 0], d.chksum [ 1], d.chksum [ 2], d.chksum [ 3], |
215 |
d.chksum [ 4], d.chksum [ 5], d.chksum [ 6], d.chksum [ 7], |
216 |
d.chksum [ 8], d.chksum [ 9], d.chksum [10], d.chksum [11], |
217 |
d.chksum [12], d.chksum [13], d.chksum [14], d.chksum [15]); |
218 |
} |
219 |
|
220 |
/** |
221 |
* Sends a face to a client if they are in pixmap mode |
222 |
* nothing gets sent in bitmap mode. |
223 |
* If nocache is true (nonzero), ignore the cache setting from the client - |
224 |
* this is needed for the askface, in which we really do want to send the |
225 |
* face (and askface is the only place that should be setting it). Otherwise, |
226 |
* we look at the facecache, and if set, send the image name. |
227 |
*/ |
228 |
void |
229 |
esrv_send_face (client *ns, short face_num, int nocache) |
230 |
{ |
231 |
if (face_num <= 0 || face_num >= faces.size ()) |
232 |
{ |
233 |
LOG (llevError, "esrv_send_face (%d) out of bounds??\n", face_num); |
234 |
return; |
235 |
} |
236 |
|
237 |
const facedata *d = face_data (face_num, ns->faceset); |
238 |
|
239 |
packet sl; |
240 |
|
241 |
if (ns->facecache && !nocache) |
242 |
{ |
243 |
sl << (ns->image2 ? "face2 " : "face1 ") |
244 |
<< uint16 (face_num); |
245 |
|
246 |
if (ns->image2) |
247 |
sl << uint8 (0); |
248 |
|
249 |
sl << uint32 (0); |
250 |
|
251 |
// how lame |
252 |
print_facename (sl, *d); |
253 |
|
254 |
ns->send_packet (sl); |
255 |
} |
256 |
else |
257 |
{ |
258 |
sl << (ns->image2 ? "image2 " : "image ") |
259 |
<< uint32 (face_num); |
260 |
|
261 |
if (ns->image2) |
262 |
sl << uint8 (0); |
263 |
|
264 |
sl << uint32 (d->data.size ()) |
265 |
<< data (d->data.data (), d->data.size ()); |
266 |
|
267 |
ns->send_packet (sl); |
268 |
} |
269 |
|
270 |
ns->faces_sent[face_num] |= NS_FACESENT_FACE; |
271 |
} |
272 |
|
273 |
/** |
274 |
* Sends the number of images, checksum of the face file, |
275 |
* and the image_info file information. See the doc/Developers/protocol |
276 |
* if you want further detail. |
277 |
*/ |
278 |
|
279 |
void |
280 |
send_image_info (client *ns, char *params) |
281 |
{ |
282 |
packet sl; |
283 |
|
284 |
//TODO: second parameter is a checksum, but it makes no sense in this current framework |
285 |
sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0); |
286 |
|
287 |
sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n"; |
288 |
|
289 |
ns->send_packet (sl); |
290 |
} |
291 |
|
292 |
/** |
293 |
* Sends requested face information. |
294 |
* \param ns socket to send to |
295 |
* \param params contains first and last index of face |
296 |
* |
297 |
* For each image in [start..stop] sends |
298 |
* - checksum |
299 |
* - name |
300 |
*/ |
301 |
void |
302 |
send_image_sums (client *ns, char *params) |
303 |
{ |
304 |
int start, stop; |
305 |
char *cp; |
306 |
|
307 |
packet sl; |
308 |
|
309 |
start = atoi (params); |
310 |
for (cp = params; *cp != '\0'; cp++) |
311 |
if (*cp == ' ') |
312 |
break; |
313 |
|
314 |
stop = atoi (cp); |
315 |
if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES) |
316 |
{ |
317 |
sl.printf ("replyinfo image_sums %d %d", start, stop); |
318 |
ns->send_packet (sl); |
319 |
sl.reset (); |
320 |
return; |
321 |
} |
322 |
|
323 |
sl.printf ("replyinfo image_sums %d %d ", start, stop); |
324 |
|
325 |
for (int i = start; i <= stop && i < faces.size (); i++) |
326 |
{ |
327 |
ns->faces_sent[i] |= NS_FACESENT_FACE; |
328 |
|
329 |
const facedata *d = face_data (i, ns->faceset); |
330 |
|
331 |
if (sl.room () < 2 + 4 + 1 + d->data.size () + 1) |
332 |
break; |
333 |
|
334 |
sl << uint16 (i) |
335 |
<< uint32 (0) // checksum |
336 |
<< uint8 (ns->faceset); |
337 |
|
338 |
print_facename (sl, *d); sl << uint8 (0); |
339 |
} |
340 |
|
341 |
/* It would make more sense to catch this pre-emptively in the code above. |
342 |
* however, if this really happens, we probably just want to cut down the |
343 |
* size to less than 1000, since that is what we claim the protocol would |
344 |
* support. |
345 |
*/ |
346 |
//TODO: taken care of above, should simply abort or make sure the above code is correct |
347 |
if (sl.length () >= MAXSOCKBUF) |
348 |
{ |
349 |
LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF); |
350 |
abort (); |
351 |
} |
352 |
|
353 |
ns->send_packet (sl); |
354 |
} |
355 |
|