| 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_FACE_SETS 20 /**< Maximum number of image sets the program will handle */ |
| 41 |
|
| 42 |
/** Information about one image */ |
| 43 |
typedef struct FaceInfo |
| 44 |
{ |
| 45 |
uint8 *data; /**< image data */ |
| 46 |
uint16 datalen; /**< length of the xpm data */ |
| 47 |
uint32 checksum; /**< Checksum of face data */ |
| 48 |
} FaceInfo; |
| 49 |
|
| 50 |
/** Information about one face set */ |
| 51 |
typedef struct |
| 52 |
{ |
| 53 |
char *prefix; /**< */ |
| 54 |
char *fullname; |
| 55 |
|
| 56 |
uint8 fallback; /**< faceset to use when an image is not found in this faceset */ |
| 57 |
char *size; |
| 58 |
char *extension; |
| 59 |
char *comment; |
| 60 |
|
| 61 |
FaceInfo *faces; /**< images in this faceset */ |
| 62 |
} FaceSets; |
| 63 |
|
| 64 |
static FaceSets facesets[MAX_FACE_SETS]; /**< All facesets */ |
| 65 |
|
| 66 |
/** |
| 67 |
* Checks specified faceset is valid |
| 68 |
* \param fsn faceset number |
| 69 |
*/ |
| 70 |
int |
| 71 |
is_valid_faceset (int fsn) |
| 72 |
{ |
| 73 |
if (fsn >= 0 && fsn < MAX_FACE_SETS && facesets[fsn].prefix) |
| 74 |
return TRUE; |
| 75 |
return FALSE; |
| 76 |
} |
| 77 |
|
| 78 |
/** |
| 79 |
* Frees all faceset information |
| 80 |
*/ |
| 81 |
void |
| 82 |
free_socket_images (void) |
| 83 |
{ |
| 84 |
int num, q; |
| 85 |
|
| 86 |
for (num = 0; num < MAX_FACE_SETS; num++) |
| 87 |
{ |
| 88 |
if (facesets[num].prefix) |
| 89 |
{ |
| 90 |
for (q = 0; q < faces.size (); q++) |
| 91 |
if (facesets[num].faces[q].data) |
| 92 |
free (facesets[num].faces[q].data); |
| 93 |
|
| 94 |
free (facesets[num].prefix); |
| 95 |
free (facesets[num].fullname); |
| 96 |
free (facesets[num].size); |
| 97 |
free (facesets[num].extension); |
| 98 |
free (facesets[num].comment); |
| 99 |
free (facesets[num].faces); |
| 100 |
} |
| 101 |
} |
| 102 |
} |
| 103 |
|
| 104 |
/** |
| 105 |
* This returns the set we will actually use when sending |
| 106 |
* a face. This is used because the image files may be sparse. |
| 107 |
* This function is recursive. imageno is the face number we are |
| 108 |
* trying to send |
| 109 |
* |
| 110 |
* If face is not found in specified faceset, tries with 'fallback' faceset. |
| 111 |
* |
| 112 |
* \param faceset faceset to check |
| 113 |
* \param imageno image number |
| 114 |
* |
| 115 |
*/ |
| 116 |
static int |
| 117 |
get_face_fallback (int faceset, int imageno) |
| 118 |
{ |
| 119 |
/* faceset 0 is supposed to have every image, so just return. Doing |
| 120 |
* so also prevents infinite loops in the case if it not having |
| 121 |
* the face, but in that case, we are likely to crash when we try |
| 122 |
* to access the data, but that is probably preferable to an infinite |
| 123 |
* loop. |
| 124 |
*/ |
| 125 |
if (faceset == 0) |
| 126 |
return 0; |
| 127 |
|
| 128 |
if (!facesets[faceset].prefix) |
| 129 |
{ |
| 130 |
LOG (llevError, "get_face_fallback called with unused set (%d)?\n", faceset); |
| 131 |
return 0; /* use default set */ |
| 132 |
} |
| 133 |
|
| 134 |
if (facesets[faceset].faces[imageno].data) |
| 135 |
return faceset; |
| 136 |
|
| 137 |
return get_face_fallback (facesets[faceset].fallback, imageno); |
| 138 |
} |
| 139 |
|
| 140 |
/** |
| 141 |
* Checks fallback are correctly defined. |
| 142 |
* This is a simple recursive function that makes sure the fallbacks |
| 143 |
* are all proper (eg, the fall back to defined sets, and also |
| 144 |
* eventually fall back to 0). At the top level, togo is set to MAX_FACE_SETS, |
| 145 |
* if togo gets to zero, it means we have a loop. |
| 146 |
* This is only run when we first load the facesets. |
| 147 |
*/ |
| 148 |
static void |
| 149 |
check_faceset_fallback (int faceset, int togo) |
| 150 |
{ |
| 151 |
int fallback = facesets[faceset].fallback; |
| 152 |
|
| 153 |
/* proper case - falls back to base set */ |
| 154 |
if (fallback == 0) |
| 155 |
return; |
| 156 |
|
| 157 |
if (!facesets[fallback].prefix) |
| 158 |
{ |
| 159 |
LOG (llevError, "Face set %d falls to non set faceset %d\n", faceset, fallback); |
| 160 |
abort (); |
| 161 |
} |
| 162 |
|
| 163 |
togo--; |
| 164 |
if (togo == 0) |
| 165 |
{ |
| 166 |
LOG (llevError, "Infinite loop found in facesets. aborting.\n"); |
| 167 |
abort (); |
| 168 |
} |
| 169 |
|
| 170 |
check_faceset_fallback (fallback, togo); |
| 171 |
} |
| 172 |
|
| 173 |
#define MAX_IMAGE_SIZE 10000 |
| 174 |
|
| 175 |
/** |
| 176 |
* Client tells us what type of faces it wants. Also sets |
| 177 |
* the caching attribute. |
| 178 |
* |
| 179 |
*/ |
| 180 |
void |
| 181 |
SetFaceMode (char *buf, int len, client *ns) |
| 182 |
{ |
| 183 |
int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE); |
| 184 |
|
| 185 |
if (mode == CF_FACE_NONE) |
| 186 |
ns->facecache = 1; |
| 187 |
else if (mode != CF_FACE_PNG) |
| 188 |
ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png"); |
| 189 |
|
| 190 |
if (mask) |
| 191 |
ns->facecache = 1; |
| 192 |
} |
| 193 |
|
| 194 |
/** |
| 195 |
* client requested an image. send it rate-limited |
| 196 |
* before flushing. |
| 197 |
*/ |
| 198 |
void |
| 199 |
AskFaceCmd (char *buf, int len, client *ns) |
| 200 |
{ |
| 201 |
int idx = 0, pri = 0; |
| 202 |
|
| 203 |
sscanf (buf, "%d %d", &idx, &pri); |
| 204 |
|
| 205 |
const facedata *d = face_data (idx, ns->faceset); |
| 206 |
|
| 207 |
if (!d) |
| 208 |
return; // doh |
| 209 |
|
| 210 |
client::ixsend ix; |
| 211 |
|
| 212 |
ix.pri = pri; |
| 213 |
ix.idx = idx; |
| 214 |
ix.ofs = d->data.size (); |
| 215 |
|
| 216 |
auto (pos, ns->ixface.end ()); |
| 217 |
|
| 218 |
if (ns->fxix < 2) |
| 219 |
{ |
| 220 |
// gcfclient does not support prioritising, older cfplus versions |
| 221 |
// do not support interleaved transfers. |
| 222 |
if (!ns->ixface.empty ()) |
| 223 |
pos = ns->ixface.end () - 1; |
| 224 |
} |
| 225 |
else |
| 226 |
{ |
| 227 |
// the by far most common case will be to insert |
| 228 |
// near the end, so little looping. |
| 229 |
while (pos != ns->ixface.begin ()) |
| 230 |
{ |
| 231 |
--pos; |
| 232 |
|
| 233 |
// sort within 2k bins, to slightly prefer smaller images |
| 234 |
if (pri > pos->pri || (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11))) |
| 235 |
{ |
| 236 |
++pos; |
| 237 |
break; |
| 238 |
} |
| 239 |
} |
| 240 |
} |
| 241 |
|
| 242 |
ns->ixface.insert (pos, ix); |
| 243 |
|
| 244 |
#if 0 |
| 245 |
for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i) |
| 246 |
fprintf (stderr, "<%d,%d> ", i->pri, i->ofs); |
| 247 |
fprintf (stderr, "\n"); |
| 248 |
#endif |
| 249 |
} |
| 250 |
|
| 251 |
/** |
| 252 |
* Tells client the picture it has to use |
| 253 |
* to smooth a picture number given as argument. |
| 254 |
*/ |
| 255 |
void |
| 256 |
AskSmooth (char *buf, int len, client *ns) |
| 257 |
{ |
| 258 |
ns->send_face (atoi (buf)); |
| 259 |
ns->flush_fx (); |
| 260 |
} |
| 261 |
|
| 262 |
// how lame |
| 263 |
static void print_facename (packet &sl, const facedata &d) |
| 264 |
{ |
| 265 |
for (int i = 0; i < CHKSUM_SIZE; ++i) |
| 266 |
sl.printf ("%02x", d.chksum [i]); |
| 267 |
} |
| 268 |
|
| 269 |
// gcfclient uses the server-provided checksum for comparison, but always |
| 270 |
// writes a broken checksum to its cache file, so we have to provide |
| 271 |
// gcfclient with the same broken (and useless) checksum just to have it |
| 272 |
// cache the image despite its bugs. |
| 273 |
static uint32 gcfclient_checksum (const facedata *d) |
| 274 |
{ |
| 275 |
uint32 csum = 0; |
| 276 |
|
| 277 |
for (std::string::const_iterator i = d->data.begin (); |
| 278 |
i != d->data.end (); |
| 279 |
++i) |
| 280 |
{ |
| 281 |
csum = rotate_right (csum); |
| 282 |
csum += *(uint8 *)&*i; |
| 283 |
} |
| 284 |
|
| 285 |
return csum; |
| 286 |
} |
| 287 |
|
| 288 |
/** |
| 289 |
* Sends a face to a client if they are in pixmap mode |
| 290 |
* nothing gets sent in bitmap mode. |
| 291 |
* If nocache is true (nonzero), ignore the cache setting from the client - |
| 292 |
* this is needed for the askface, in which we really do want to send the |
| 293 |
* face (and askface is the only place that should be setting it). Otherwise, |
| 294 |
* we look at the facecache, and if set, send the image name. |
| 295 |
*/ |
| 296 |
void |
| 297 |
client::send_face (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_face (%d) out of bounds??\n", facenum); |
| 308 |
return; |
| 309 |
} |
| 310 |
|
| 311 |
// refuse tos end non-image faces |
| 312 |
if (d->type) |
| 313 |
return; |
| 314 |
|
| 315 |
if (!must_send_face (facenum)) |
| 316 |
return; |
| 317 |
|
| 318 |
// if for some reason we let a client without face caching connect, |
| 319 |
// we better support that decision here and implement it. |
| 320 |
if (!facecache) |
| 321 |
return send_image (facenum); |
| 322 |
|
| 323 |
if (fxix) |
| 324 |
{ |
| 325 |
fxface.push_back (facenum); |
| 326 |
return; |
| 327 |
} |
| 328 |
|
| 329 |
packet sl; |
| 330 |
|
| 331 |
if (force_face0) |
| 332 |
sl << "face " << uint16 (facenum); |
| 333 |
else if (image2) |
| 334 |
sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0); |
| 335 |
else |
| 336 |
sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0); |
| 337 |
|
| 338 |
// how lame |
| 339 |
print_facename (sl, *d); |
| 340 |
send_packet (sl); |
| 341 |
|
| 342 |
if (EMI_smooth) |
| 343 |
{ |
| 344 |
faceinfo *f = face_info (facenum); |
| 345 |
|
| 346 |
if (f->smooth) |
| 347 |
{ |
| 348 |
send_face (f->smooth); |
| 349 |
|
| 350 |
packet sl ("smooth"); |
| 351 |
|
| 352 |
sl << uint16 (facenum) |
| 353 |
<< uint16 (f->smooth); |
| 354 |
|
| 355 |
send_packet (sl); |
| 356 |
} |
| 357 |
} |
| 358 |
} |
| 359 |
|
| 360 |
void client::flush_fx () |
| 361 |
{ |
| 362 |
while (!fxface.empty ()) |
| 363 |
{ |
| 364 |
packet fx ("fx"); |
| 365 |
packet sx ("sx"); |
| 366 |
|
| 367 |
do |
| 368 |
{ |
| 369 |
faceidx facenum = fxface.back (); fxface.pop_back (); |
| 370 |
|
| 371 |
const facedata *d = face_data (facenum, faceset); |
| 372 |
|
| 373 |
if (d) |
| 374 |
{ |
| 375 |
fx << ber32 (facenum) |
| 376 |
<< data8 (d->chksum, CHKSUM_SIZE); |
| 377 |
|
| 378 |
if (smoothing) |
| 379 |
{ |
| 380 |
faceinfo *f = face_info (facenum); |
| 381 |
|
| 382 |
if (f->smooth) |
| 383 |
{ |
| 384 |
send_face (f->smooth); |
| 385 |
sx << ber32 (facenum) |
| 386 |
<< ber32 (f->smooth) |
| 387 |
<< ber32 (f->smoothlevel); |
| 388 |
} |
| 389 |
} |
| 390 |
} |
| 391 |
} |
| 392 |
while (!fxface.empty () |
| 393 |
&& fx.room () > ber32::size + CHKSUM_SIZE + 1 |
| 394 |
&& sx.room () > ber32::size * 3); |
| 395 |
|
| 396 |
send_packet (fx); |
| 397 |
if (sx.length () > 3) send_packet (sx); |
| 398 |
} |
| 399 |
} |
| 400 |
|
| 401 |
void |
| 402 |
client::send_image (faceidx facenum) |
| 403 |
{ |
| 404 |
// never send face 0. ever. it does not exist. |
| 405 |
if (!facenum) |
| 406 |
return; |
| 407 |
|
| 408 |
const facedata *d = face_data (facenum, faceset); |
| 409 |
|
| 410 |
faces_sent[facenum] = true; |
| 411 |
|
| 412 |
if (!d) |
| 413 |
{ |
| 414 |
LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum); |
| 415 |
return; |
| 416 |
} |
| 417 |
|
| 418 |
//TODO: check type here? |
| 419 |
|
| 420 |
if (force_image_newmap) |
| 421 |
force_newmap = true; |
| 422 |
|
| 423 |
packet sl; |
| 424 |
|
| 425 |
sl << (image2 ? "image2 " : "image ") |
| 426 |
<< uint32 (facenum); |
| 427 |
|
| 428 |
if (image2) |
| 429 |
sl << uint8 (0); |
| 430 |
|
| 431 |
sl << uint32 (d->data.size ()) |
| 432 |
<< data (d->data.data (), d->data.size ()); |
| 433 |
|
| 434 |
send_packet (sl); |
| 435 |
} |
| 436 |
|
| 437 |
// send all faces of this object to the client |
| 438 |
// this uses more bandwidth initially, but makes |
| 439 |
// animations look much smoother, and every client |
| 440 |
// is supposed to do client-side caching anyways. |
| 441 |
void |
| 442 |
client::send_faces (object *ob) |
| 443 |
{ |
| 444 |
send_face (ob->face); |
| 445 |
|
| 446 |
if (ob->animation_id) |
| 447 |
{ |
| 448 |
animation &anim = animations [ob->animation_id]; |
| 449 |
|
| 450 |
for (int i = 0; i < anim.num_animations; i++) |
| 451 |
send_face (anim.faces [i]); |
| 452 |
} |
| 453 |
} |
| 454 |
|
| 455 |
/** |
| 456 |
* Need to send an animation sequence to the client. |
| 457 |
* We will send appropriate face commands to the client if we haven't |
| 458 |
* sent them the face yet (this can become quite costly in terms of |
| 459 |
* how much we are sending - on the other hand, this should only happen |
| 460 |
* when the player logs in and picks stuff up. |
| 461 |
*/ |
| 462 |
void |
| 463 |
client::send_animation (short anim_num) |
| 464 |
{ |
| 465 |
/* Do some checking on the anim_num we got. Note that the animations |
| 466 |
* are added in contigous order, so if the number is in the valid |
| 467 |
* range, it must be a valid animation. |
| 468 |
*/ |
| 469 |
if (anim_num < 0 || anim_num >= animations.size ()) |
| 470 |
{ |
| 471 |
LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num); |
| 472 |
return; |
| 473 |
} |
| 474 |
|
| 475 |
packet sl ("anim"); |
| 476 |
|
| 477 |
sl << uint16 (anim_num) |
| 478 |
<< uint16 (0); /* flags - not used right now */ |
| 479 |
|
| 480 |
/* Build up the list of faces. Also, send any information (ie, the |
| 481 |
* the face itself) down to the client. |
| 482 |
*/ |
| 483 |
for (int i = 0; i < animations[anim_num].num_animations; i++) |
| 484 |
{ |
| 485 |
send_face (animations[anim_num].faces[i]); |
| 486 |
sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ |
| 487 |
} |
| 488 |
|
| 489 |
send_packet (sl); |
| 490 |
|
| 491 |
anims_sent[anim_num] = 1; |
| 492 |
} |
| 493 |
|
| 494 |
/** |
| 495 |
* Sends the number of images, checksum of the face file, |
| 496 |
* and the image_info file information. See the doc/Developers/protocol |
| 497 |
* if you want further detail. |
| 498 |
*/ |
| 499 |
void |
| 500 |
send_image_info (client *ns, char *params) |
| 501 |
{ |
| 502 |
packet sl; |
| 503 |
|
| 504 |
//TODO: second parameter is a checksum, but it makes no sense in this current framework |
| 505 |
sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0); |
| 506 |
|
| 507 |
sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n"; |
| 508 |
|
| 509 |
ns->send_packet (sl); |
| 510 |
} |
| 511 |
|
| 512 |
/** |
| 513 |
* Sends requested face information. |
| 514 |
* \param ns socket to send to |
| 515 |
* \param params contains first and last index of face |
| 516 |
* |
| 517 |
* For each image in [start..stop] sends |
| 518 |
* - checksum |
| 519 |
* - name |
| 520 |
*/ |
| 521 |
void |
| 522 |
send_image_sums (client *ns, char *params) |
| 523 |
{ |
| 524 |
int start, stop; |
| 525 |
char *cp; |
| 526 |
|
| 527 |
packet sl; |
| 528 |
|
| 529 |
start = atoi (params); |
| 530 |
for (cp = params; *cp != '\0'; cp++) |
| 531 |
if (*cp == ' ') |
| 532 |
break; |
| 533 |
|
| 534 |
stop = atoi (cp); |
| 535 |
if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES) |
| 536 |
{ |
| 537 |
sl.printf ("replyinfo image_sums %d %d", start, stop); |
| 538 |
ns->send_packet (sl); |
| 539 |
sl.reset (); |
| 540 |
return; |
| 541 |
} |
| 542 |
|
| 543 |
sl.printf ("replyinfo image_sums %d %d ", start, stop); |
| 544 |
|
| 545 |
for (int i = start; i <= stop && i < faces.size (); i++) |
| 546 |
{ |
| 547 |
ns->faces_sent[i] = true; |
| 548 |
|
| 549 |
const facedata *d = face_data (i, ns->faceset); |
| 550 |
|
| 551 |
if (sl.room () < 2 + 4 + 1 + d->data.size () + 1) |
| 552 |
break; |
| 553 |
|
| 554 |
sl << uint16 (i) |
| 555 |
<< uint32 (0) // checksum |
| 556 |
<< uint8 (ns->faceset); |
| 557 |
|
| 558 |
print_facename (sl, *d); sl << uint8 (0); |
| 559 |
} |
| 560 |
|
| 561 |
/* It would make more sense to catch this pre-emptively in the code above. |
| 562 |
* however, if this really happens, we probably just want to cut down the |
| 563 |
* size to less than 1000, since that is what we claim the protocol would |
| 564 |
* support. |
| 565 |
*/ |
| 566 |
//TODO: taken care of above, should simply abort or make sure the above code is correct |
| 567 |
if (sl.length () >= MAXSOCKBUF) |
| 568 |
{ |
| 569 |
LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF); |
| 570 |
abort (); |
| 571 |
} |
| 572 |
|
| 573 |
ns->send_packet (sl); |
| 574 |
} |
| 575 |
|
