| 1 | /* |
1 | /* |
| 2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
| 3 | * |
3 | * |
| 4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
4 | * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
| 5 | * Copyright (©) 2001,2007 Mark Wedel |
5 | * Copyright (©) 2001 Mark Wedel |
| 6 | * Copyright (©) 1992,2007 Frank Tore Johansen |
6 | * Copyright (©) 1992 Frank Tore Johansen |
| 7 | * |
7 | * |
| 8 | * Crossfire TRT is free software: you can redistribute it and/or modify |
8 | * Deliantra is free software: you can redistribute it and/or modify it under |
| 9 | * it under the terms of the GNU General Public License as published by |
9 | * the terms of the Affero GNU General Public License as published by the |
| 10 | * the Free Software Foundation, either version 3 of the License, or |
10 | * Free Software Foundation, either version 3 of the License, or (at your |
| 11 | * (at your option) any later version. |
11 | * option) any later version. |
| 12 | * |
12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU General Public License for more details. |
16 | * GNU General Public License for more details. |
| 17 | * |
17 | * |
| 18 | * You should have received a copy of the GNU General Public License |
18 | * You should have received a copy of the Affero GNU General Public License |
| 19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
19 | * and the GNU General Public License along with this program. If not, see |
|
|
20 | * <http://www.gnu.org/licenses/>. |
| 20 | * |
21 | * |
| 21 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
22 | * The authors can be reached via e-mail to <support@deliantra.net> |
| 22 | */ |
23 | */ |
| 23 | |
24 | |
| 24 | /** \file |
25 | /** \file |
| 25 | * Image related communication |
26 | * Image related communication |
| 26 | * |
27 | * |
| … | |
… | |
| 38 | #include "crc.h" |
39 | #include "crc.h" |
| 39 | |
40 | |
| 40 | #define MAX_IMAGE_SIZE 10000 |
41 | #define MAX_IMAGE_SIZE 10000 |
| 41 | |
42 | |
| 42 | /** |
43 | /** |
| 43 | * Client tells us what type of faces it wants. Also sets |
|
|
| 44 | * the caching attribute. |
|
|
| 45 | * |
|
|
| 46 | */ |
|
|
| 47 | void |
|
|
| 48 | SetFaceMode (char *buf, int len, client *ns) |
|
|
| 49 | { |
|
|
| 50 | int mask = (atoi (buf) & CF_FACE_CACHE), mode = (atoi (buf) & ~CF_FACE_CACHE); |
|
|
| 51 | |
|
|
| 52 | if (mode == CF_FACE_NONE) |
|
|
| 53 | ns->facecache = 1; |
|
|
| 54 | else if (mode != CF_FACE_PNG) |
|
|
| 55 | ns->send_packet_printf ("drawinfo %d %s", NDI_RED, "Warning - send unsupported face mode. Will use Png"); |
|
|
| 56 | |
|
|
| 57 | if (mask) |
|
|
| 58 | ns->facecache = 1; |
|
|
| 59 | } |
|
|
| 60 | |
|
|
| 61 | /** |
|
|
| 62 | * client requested an image. send it rate-limited |
44 | * client requested an image. send it rate-limited |
| 63 | * before flushing. |
45 | * before flushing. |
| 64 | */ |
46 | */ |
| 65 | void |
47 | void |
| 66 | AskFaceCmd (char *buf, int len, client *ns) |
48 | AskFaceCmd (char *buf, int len, client *ns) |
| 67 | { |
49 | { |
| 68 | int idx = 0, pri = 0; |
50 | int idx = 0, pri = 0; |
| 69 | |
51 | |
| 70 | sscanf (buf, "%d %d", &idx, &pri); |
52 | sscanf (buf, "%d %d", &idx, &pri); |
|
|
53 | |
|
|
54 | //TODO: somehow fetch default priority from send_fx here |
| 71 | |
55 | |
| 72 | const facedata *d = face_data (idx, ns->faceset); |
56 | const facedata *d = face_data (idx, ns->faceset); |
| 73 | |
57 | |
| 74 | if (!d) |
58 | if (!d) |
| 75 | return; // doh |
59 | return; // doh |
| … | |
… | |
| 80 | ix.idx = idx; |
64 | ix.idx = idx; |
| 81 | ix.ofs = d->data.size (); |
65 | ix.ofs = d->data.size (); |
| 82 | |
66 | |
| 83 | auto (pos, ns->ixface.end ()); |
67 | auto (pos, ns->ixface.end ()); |
| 84 | |
68 | |
| 85 | if (ns->fxix < 2) |
|
|
| 86 | { |
|
|
| 87 | // gcfclient does not support prioritising, older cfplus versions |
|
|
| 88 | // do not support interleaved transfers. |
|
|
| 89 | if (!ns->ixface.empty ()) |
|
|
| 90 | pos = ns->ixface.end () - 1; |
|
|
| 91 | } |
|
|
| 92 | else |
|
|
| 93 | { |
|
|
| 94 | // the by far most common case will be to insert |
69 | // the by far most common case will be to insert |
| 95 | // near the end, so little looping. |
70 | // near the end, so little looping. |
| 96 | while (pos != ns->ixface.begin ()) |
71 | while (pos != ns->ixface.begin ()) |
|
|
72 | { |
|
|
73 | --pos; |
|
|
74 | |
|
|
75 | // sort within 2k bins, to slightly prefer smaller images |
|
|
76 | if (pri > pos->pri || (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11))) |
| 97 | { |
77 | { |
| 98 | --pos; |
|
|
| 99 | |
|
|
| 100 | // sort within 2k bins, to slightly prefer smaller images |
|
|
| 101 | if (pri > pos->pri || (pri == pos->pri && (ix.ofs >> 11) <= (pos->ofs >> 11))) |
|
|
| 102 | { |
|
|
| 103 | ++pos; |
78 | ++pos; |
| 104 | break; |
79 | break; |
| 105 | } |
|
|
| 106 | } |
80 | } |
| 107 | } |
81 | } |
| 108 | |
82 | |
| 109 | ns->ixface.insert (pos, ix); |
83 | ns->ixface.insert (pos, ix); |
| 110 | |
84 | |
| 111 | #if 0 |
85 | #if 0 |
| 112 | for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i) |
86 | for (auto (i, ns->ixface.begin ()); i != ns->ixface.end (); ++i) |
| 113 | fprintf (stderr, "<%d,%d> ", i->pri, i->ofs); |
87 | fprintf (stderr, "<%d,%d> ", i->pri, i->ofs); |
| 114 | fprintf (stderr, "\n"); |
88 | fprintf (stderr, "\n"); |
| 115 | #endif |
89 | #endif |
| 116 | } |
|
|
| 117 | |
|
|
| 118 | /** |
|
|
| 119 | * Tells client the picture it has to use |
|
|
| 120 | * to smooth a picture number given as argument. |
|
|
| 121 | */ |
|
|
| 122 | void |
|
|
| 123 | AskSmooth (char *buf, int len, client *ns) |
|
|
| 124 | { |
|
|
| 125 | ns->send_face (atoi (buf), -100); |
|
|
| 126 | ns->flush_fx (); |
|
|
| 127 | } |
|
|
| 128 | |
|
|
| 129 | // how lame |
|
|
| 130 | static void print_facename (packet &sl, const facedata &d) |
|
|
| 131 | { |
|
|
| 132 | for (int i = 0; i < CHKSUM_SIZE; ++i) |
|
|
| 133 | sl.printf ("%02x", d.chksum [i]); |
|
|
| 134 | } |
|
|
| 135 | |
|
|
| 136 | // gcfclient uses the server-provided checksum for comparison, but always |
|
|
| 137 | // writes a broken checksum to its cache file, so we have to provide |
|
|
| 138 | // gcfclient with the same broken (and useless) checksum just to have it |
|
|
| 139 | // cache the image despite its bugs. |
|
|
| 140 | static uint32 gcfclient_checksum (const facedata *d) |
|
|
| 141 | { |
|
|
| 142 | uint32 csum = 0; |
|
|
| 143 | |
|
|
| 144 | for (std::string::const_iterator i = d->data.begin (); |
|
|
| 145 | i != d->data.end (); |
|
|
| 146 | ++i) |
|
|
| 147 | { |
|
|
| 148 | csum = rotate_right (csum); |
|
|
| 149 | csum += *(uint8 *)&*i; |
|
|
| 150 | } |
|
|
| 151 | |
|
|
| 152 | return csum; |
|
|
| 153 | } |
90 | } |
| 154 | |
91 | |
| 155 | /** |
92 | /** |
| 156 | * Sends a face to a client if they are in pixmap mode |
93 | * Sends a face to a client if they are in pixmap mode |
| 157 | * nothing gets sent in bitmap mode. |
94 | * nothing gets sent in bitmap mode. |
| … | |
… | |
| 169 | |
106 | |
| 170 | faceinfo *f = face_info (facenum); |
107 | faceinfo *f = face_info (facenum); |
| 171 | |
108 | |
| 172 | if (!f) |
109 | if (!f) |
| 173 | { |
110 | { |
| 174 | LOG (llevError, "client::send_face (%d) out of bounds??\n", facenum); |
111 | LOG (llevError | logBacktrace, "client::send_face (%d) out of bounds??\n", facenum); |
| 175 | return; |
112 | return; |
| 176 | } |
113 | } |
| 177 | |
114 | |
| 178 | // refuse to send non-image faces |
115 | // refuse to send non-image faces |
| 179 | if (!fx_want [f->type]) |
116 | if (!fx_want [f->type]) |
| … | |
… | |
| 182 | if (faces_sent [facenum]) |
119 | if (faces_sent [facenum]) |
| 183 | return; |
120 | return; |
| 184 | |
121 | |
| 185 | faces_sent[facenum] = true; |
122 | faces_sent[facenum] = true; |
| 186 | |
123 | |
| 187 | // if for some reason we let a client without face caching connect, |
|
|
| 188 | // we better support that decision here and implement it. |
|
|
| 189 | if (!facecache) |
|
|
| 190 | return send_image (facenum); |
|
|
| 191 | |
|
|
| 192 | if (fxix) |
|
|
| 193 | { |
|
|
| 194 | fxface.push_back (facenum); |
124 | fxface.push_back (facenum); |
| 195 | return; |
|
|
| 196 | } |
|
|
| 197 | |
|
|
| 198 | const facedata *d = f->data (faceset); |
|
|
| 199 | |
|
|
| 200 | packet sl; |
|
|
| 201 | |
|
|
| 202 | if (force_face0) |
|
|
| 203 | sl << "face " << uint16 (facenum); |
|
|
| 204 | else if (image2) |
|
|
| 205 | sl << "face2 " << uint16 (facenum) << uint8 (0) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0); |
|
|
| 206 | else |
|
|
| 207 | sl << "face1 " << uint16 (facenum) << uint32 (force_bad_checksum ? gcfclient_checksum (d) : 0); |
|
|
| 208 | |
|
|
| 209 | // how lame |
|
|
| 210 | print_facename (sl, *d); |
|
|
| 211 | send_packet (sl); |
|
|
| 212 | |
|
|
| 213 | if (EMI_smooth) |
|
|
| 214 | { |
|
|
| 215 | if (f->smooth) |
|
|
| 216 | { |
|
|
| 217 | send_face (f->smooth); |
|
|
| 218 | |
|
|
| 219 | packet sl ("smooth"); |
|
|
| 220 | |
|
|
| 221 | sl << uint16 (facenum) |
|
|
| 222 | << uint16 (f->smooth); |
|
|
| 223 | |
|
|
| 224 | send_packet (sl); |
|
|
| 225 | } |
|
|
| 226 | } |
|
|
| 227 | } |
125 | } |
| 228 | |
126 | |
| 229 | void client::flush_fx () |
127 | void client::flush_fx () |
| 230 | { |
128 | { |
| 231 | while (!fxface.empty ()) |
129 | while (!fxface.empty ()) |
| … | |
… | |
| 249 | } |
147 | } |
| 250 | |
148 | |
| 251 | const facedata *d = f->data (faceset); |
149 | const facedata *d = f->data (faceset); |
| 252 | |
150 | |
| 253 | fx << ber32 (facenum) |
151 | fx << ber32 (facenum) |
| 254 | << data8 (d->chksum, CHKSUM_SIZE); |
152 | << data8 (d->chksum, d->chksum_len); |
| 255 | |
153 | |
| 256 | if (smoothing) |
154 | if (smoothing) |
| 257 | { |
155 | { |
| 258 | faceinfo *f = face_info (facenum); |
156 | faceinfo *f = face_info (facenum); |
| 259 | |
157 | |
| … | |
… | |
| 267 | } |
165 | } |
| 268 | } |
166 | } |
| 269 | } |
167 | } |
| 270 | } |
168 | } |
| 271 | while (!fxface.empty () |
169 | while (!fxface.empty () |
| 272 | && fx.room () > ber32::size + CHKSUM_SIZE + 1 + 3 /* type switch */ |
170 | && fx.room () > ber32::size + CHKSUM_MAXLEN + 1 + 3 /* type switch */ |
| 273 | && sx.room () > ber32::size * 3); |
171 | && sx.room () > ber32::size * 3); |
| 274 | |
172 | |
| 275 | send_packet (fx); |
173 | send_packet (fx); |
| 276 | if (sx.length () > 3) send_packet (sx); |
174 | if (sx.length () > 3) send_packet (sx); |
| 277 | } |
175 | } |
| 278 | } |
|
|
| 279 | |
|
|
| 280 | void |
|
|
| 281 | client::send_image (faceidx facenum) |
|
|
| 282 | { |
|
|
| 283 | // never send face 0. ever. it does not exist. |
|
|
| 284 | if (!facenum) |
|
|
| 285 | return; |
|
|
| 286 | |
|
|
| 287 | const facedata *d = face_data (facenum, faceset); |
|
|
| 288 | |
|
|
| 289 | faces_sent[facenum] = true; |
|
|
| 290 | |
|
|
| 291 | if (!d) |
|
|
| 292 | { |
|
|
| 293 | LOG (llevError, "client::send_image (%d) out of bounds??\n", facenum); |
|
|
| 294 | return; |
|
|
| 295 | } |
|
|
| 296 | |
|
|
| 297 | //TODO: check type here? |
|
|
| 298 | |
|
|
| 299 | if (force_image_newmap) |
|
|
| 300 | force_newmap = true; |
|
|
| 301 | |
|
|
| 302 | packet sl; |
|
|
| 303 | |
|
|
| 304 | sl << (image2 ? "image2 " : "image ") |
|
|
| 305 | << uint32 (facenum); |
|
|
| 306 | |
|
|
| 307 | if (image2) |
|
|
| 308 | sl << uint8 (0); |
|
|
| 309 | |
|
|
| 310 | sl << uint32 (d->data.size ()) |
|
|
| 311 | << data (d->data.data (), d->data.size ()); |
|
|
| 312 | |
|
|
| 313 | send_packet (sl); |
|
|
| 314 | } |
176 | } |
| 315 | |
177 | |
| 316 | // send all faces of this object to the client |
178 | // send all faces of this object to the client |
| 317 | // this uses more bandwidth initially, but makes |
179 | // this uses more bandwidth initially, but makes |
| 318 | // animations look much smoother, and every client |
180 | // animations look much smoother, and every client |
| … | |
… | |
| 322 | { |
184 | { |
| 323 | send_face (ob->face, 10); |
185 | send_face (ob->face, 10); |
| 324 | |
186 | |
| 325 | if (ob->animation_id) |
187 | if (ob->animation_id) |
| 326 | { |
188 | { |
| 327 | animation &anim = animations [ob->animation_id]; |
189 | const animation &anim = ob->anim (); |
| 328 | |
190 | |
| 329 | for (int i = 0; i < anim.num_animations; i++) |
191 | for (int i = 0; i < anim.num_animations; i++) |
| 330 | send_face (anim.faces [i], -10); |
192 | send_face (anim.faces [i], -10); |
| 331 | } |
193 | } |
| 332 | } |
194 | } |
| … | |
… | |
| 340 | */ |
202 | */ |
| 341 | void |
203 | void |
| 342 | client::send_animation (short anim_num) |
204 | client::send_animation (short anim_num) |
| 343 | { |
205 | { |
| 344 | /* Do some checking on the anim_num we got. Note that the animations |
206 | /* Do some checking on the anim_num we got. Note that the animations |
| 345 | * are added in contigous order, so if the number is in the valid |
207 | * are added in contiguous order, so if the number is in the valid |
| 346 | * range, it must be a valid animation. |
208 | * range, it must be a valid animation. |
| 347 | */ |
209 | */ |
| 348 | if (anim_num < 0 || anim_num >= animations.size ()) |
210 | if (anim_num < 0 || anim_num >= animations.size ()) |
| 349 | { |
211 | { |
| 350 | LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num); |
212 | LOG (llevError, "esrv_send_anim (%d) out of bounds??\n", anim_num); |
| … | |
… | |
| 360 | * the face itself) down to the client. |
222 | * the face itself) down to the client. |
| 361 | */ |
223 | */ |
| 362 | for (int i = 0; i < animations[anim_num].num_animations; i++) |
224 | for (int i = 0; i < animations[anim_num].num_animations; i++) |
| 363 | { |
225 | { |
| 364 | send_face (animations[anim_num].faces[i], -20); |
226 | send_face (animations[anim_num].faces[i], -20); |
| 365 | sl << uint16 (animations[anim_num].faces[i]); /* flags - not used right now */ |
227 | sl << uint16 (animations[anim_num].faces[i]); |
| 366 | } |
228 | } |
| 367 | |
229 | |
| 368 | send_packet (sl); |
230 | send_packet (sl); |
| 369 | |
231 | |
| 370 | anims_sent[anim_num] = 1; |
232 | anims_sent[anim_num] = 1; |
| 371 | } |
233 | } |
| 372 | |
234 | |
| 373 | /** |
|
|
| 374 | * Sends the number of images, checksum of the face file, |
|
|
| 375 | * and the image_info file information. See the doc/Developers/protocol |
|
|
| 376 | * if you want further detail. |
|
|
| 377 | */ |
|
|
| 378 | void |
235 | void |
| 379 | send_image_info (client *ns, char *params) |
236 | client::invalidate_face (faceidx idx) |
| 380 | { |
237 | { |
| 381 | packet sl; |
238 | faces_sent [idx] = false; |
| 382 | |
239 | force_newmap = true; |
| 383 | //TODO: second parameter is a checksum, but it makes no sense in this current framework |
|
|
| 384 | sl.printf ("replyinfo image_info\n%d\n%u\n", MAX_FACES, 0); |
|
|
| 385 | |
|
|
| 386 | sl << "0:base:standard:0:32x32:none:The old 32x32 faceset.\n"; |
|
|
| 387 | |
|
|
| 388 | ns->send_packet (sl); |
|
|
| 389 | } |
240 | } |
| 390 | |
241 | |
| 391 | /** |
|
|
| 392 | * Sends requested face information. |
|
|
| 393 | * \param ns socket to send to |
|
|
| 394 | * \param params contains first and last index of face |
|
|
| 395 | * |
|
|
| 396 | * For each image in [start..stop] sends |
|
|
| 397 | * - checksum |
|
|
| 398 | * - name |
|
|
| 399 | */ |
|
|
| 400 | void |
242 | void |
| 401 | send_image_sums (client *ns, char *params) |
243 | client::invalidate_all_faces () |
| 402 | { |
244 | { |
| 403 | int start, stop; |
245 | faces_sent.reset (); |
| 404 | char *cp; |
246 | force_newmap = true; |
| 405 | |
|
|
| 406 | packet sl; |
|
|
| 407 | |
|
|
| 408 | start = atoi (params); |
|
|
| 409 | for (cp = params; *cp != '\0'; cp++) |
|
|
| 410 | if (*cp == ' ') |
|
|
| 411 | break; |
|
|
| 412 | |
|
|
| 413 | stop = atoi (cp); |
|
|
| 414 | if (stop < start || *cp == '\0' || (stop - start) > 1000 || stop >= MAX_FACES) |
|
|
| 415 | { |
|
|
| 416 | sl.printf ("replyinfo image_sums %d %d", start, stop); |
|
|
| 417 | ns->send_packet (sl); |
|
|
| 418 | sl.reset (); |
|
|
| 419 | return; |
|
|
| 420 | } |
|
|
| 421 | |
|
|
| 422 | sl.printf ("replyinfo image_sums %d %d ", start, stop); |
|
|
| 423 | |
|
|
| 424 | for (int i = start; i <= stop && i < faces.size (); i++) |
|
|
| 425 | { |
|
|
| 426 | ns->faces_sent[i] = true; |
|
|
| 427 | |
|
|
| 428 | const facedata *d = face_data (i, ns->faceset); |
|
|
| 429 | |
|
|
| 430 | if (sl.room () < 2 + 4 + 1 + d->data.size () + 1) |
|
|
| 431 | break; |
|
|
| 432 | |
|
|
| 433 | sl << uint16 (i) |
|
|
| 434 | << uint32 (0) // checksum |
|
|
| 435 | << uint8 (ns->faceset); |
|
|
| 436 | |
|
|
| 437 | print_facename (sl, *d); sl << uint8 (0); |
|
|
| 438 | } |
|
|
| 439 | |
|
|
| 440 | /* It would make more sense to catch this pre-emptively in the code above. |
|
|
| 441 | * however, if this really happens, we probably just want to cut down the |
|
|
| 442 | * size to less than 1000, since that is what we claim the protocol would |
|
|
| 443 | * support. |
|
|
| 444 | */ |
|
|
| 445 | //TODO: taken care of above, should simply abort or make sure the above code is correct |
|
|
| 446 | if (sl.length () >= MAXSOCKBUF) |
|
|
| 447 | { |
|
|
| 448 | LOG (llevError, "send_image_send: buffer overrun, %d > %d\n", sl.length (), MAXSOCKBUF); |
|
|
| 449 | abort (); |
|
|
| 450 | } |
|
|
| 451 | |
|
|
| 452 | ns->send_packet (sl); |
|
|
| 453 | } |
247 | } |
| 454 | |
248 | |
