ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.90
Committed: Thu Nov 8 02:28:21 2012 UTC (11 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.89: +93 -76 lines
Log Message:
parse more than one webscoket frame per read (bug), do not require a length prefix

File Contents

# Content
1 /*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 *
6 * Deliantra is free software: you can redistribute it and/or modify it under
7 * the terms of the Affero GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the Affero GNU General Public License
17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>.
19 *
20 * The authors can be reached via e-mail to <support@deliantra.net>
21 */
22
23 using namespace std;
24
25 #include <global.h>
26 #include <sproto.h>
27 #include <cstdarg>
28
29 #if HAVE_TCP_INFO
30 # include <sys/types.h>
31 # include <sys/socket.h>
32 # include <netinet/in.h>
33 # include <netinet/tcp.h>
34 #endif
35
36 // force a packet when idle for more than this many seconds,
37 // forcing an ack regularly.
38 #define IDLE_PING 2.
39
40 void
41 client::flush ()
42 {
43 if (destroyed ())
44 return;
45
46 /**
47 * Writes data to socket.
48 *
49 * When the socket is clear to write, and we have backlogged data, this
50 * is called to write it out.
51 */
52
53 // write a nop to the socket at least every IDLE_PING seconds.
54 if (!outputbuffer.len)
55 {
56 if (last_send + IDLE_PING <= NOW && pl && pl->active)
57 {
58 // this is a bit ugly, but map1a seems to be the only
59 // nop'able command and it is quite small.
60 packet sl ("map1a");
61 send_packet (sl);
62 }
63 else
64 return;
65 }
66
67 if (socket_ev.poll () & EV_WRITE)
68 return;
69
70 last_send = NOW;
71 write_outputbuffer ();
72 }
73
74 void
75 client::write_outputbuffer ()
76 {
77 while (outputbuffer.len)
78 {
79 int res = write (fd, outputbuffer.data + outputbuffer.start,
80 min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
81
82 if (res > 0)
83 {
84 outputbuffer.start += res;
85 /* wrap back to start of buffer */
86 if (outputbuffer.start == SOCKETBUFSIZE)
87 outputbuffer.start = 0;
88
89 outputbuffer.len -= res;
90 }
91 else if (res == 0)
92 {
93 LOG (llevError, "socket write failed, connection closed.\n");
94 destroy ();
95 return;
96 }
97 else if (errno == EINTR)
98 {
99 // just retry
100 }
101 else if (errno == EAGAIN)
102 {
103 // delay till ready
104 socket_ev.poll (socket_ev.poll () | EV_WRITE);
105 socket_ev.start ();
106 return;
107 }
108 else
109 {
110 LOG (llevError, "socket write failed: %s\n", strerror (errno));
111 destroy ();
112 return;
113 }
114 }
115
116 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
117 }
118
119 /******************************************************************************
120 *
121 * Start of read routines.
122 *
123 ******************************************************************************/
124
125 int
126 client::next_packet ()
127 {
128 if (inbuf_len >= 2)
129 {
130 int pkt_len = (inbuf [0] << 8) | inbuf [1];
131
132 if (inbuf_len >= 2 + pkt_len)
133 return 2 + pkt_len;
134
135 if (inbuf_len == sizeof (inbuf))
136 {
137 send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED | NDI_REPLY);
138 destroy ();
139 return -1;
140 }
141 }
142
143 return 0;
144 }
145
146 void
147 client::skip_packet (int len)
148 {
149 inbuf_len -= len;
150 memmove (inbuf, inbuf + len, inbuf_len);
151 }
152
153 /*****************************************************************************
154 * Start of command dispatch area.
155 * The commands here are protocol commands.
156 ****************************************************************************/
157
158 // SocketCommand, PlayingCommand, should not exist with those ugly casts
159 #define SC(cb) (void *)static_cast<void (*)(char *, int, client *)>(cb),
160 #define PC(cb) (void *)static_cast<void (*)(char *, int, player *)>(cb), PF_PLAYER |
161
162 static void
163 NopCmd (char *, int, client *)
164 {
165 // do nothing
166 }
167
168 /**
169 * Dispatch table for the server.
170 */
171 static struct packet_type packets[] = {
172 {"ncom", PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 },
173 {"command", PC(PlayerCmd) PF_PLAYING | PF_COMMAND0 },
174
175 {"examine", PC(ExamineCmd) PF_PLAYING },
176 {"ex", PC(ExCmd) PF_PLAYING },
177 {"apply", PC(ApplyCmd) PF_PLAYING },
178 {"lookat", PC(LookAt) PF_PLAYING },
179 {"lock", PC(LockItem) PF_PLAYING },
180 {"mark", PC(MarkItem) PF_PLAYING },
181 {"move", PC(MoveCmd) PF_PLAYING },
182 {"ext", PC(ExtCmd) 0 }, // CF+/Deliantra
183 {"mapredraw", PC(MapRedrawCmd) 0 },
184 {"mapinfo", PC(MapInfoCmd) 0 }, // CF+/Deliantra
185
186 {"reply", SC(ReplyCmd) 0 },
187 {"exti", SC(ExtiCmd) 0 }, // CF+/Deliantra
188 {"addme", SC(AddMeCmd) 0 },
189 {"askface", SC(AskFaceCmd) 0 },
190 {"requestinfo", SC(RequestInfo) 0 },
191 {"setsound", SC(SetSound) 0 },
192 {"setup", SC(SetUp) 0 },
193 {"version", SC(VersionCmd) 0 },
194
195 {"toggleextendedtext", SC(NopCmd) 0 }, // deliantra: disabled
196 };
197
198 bool
199 client::may_execute (const packet_type *pkt) const
200 {
201 return (!(pkt->flags & PF_PLAYER) || pl)
202 && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
203 }
204
205 // HACK: some commands currently should be executed
206 // even when the player is frozen. this hack detects
207 // those commands. it should be folded into may_execute,
208 // but kept seperate to emphasise the hack aspect, i.e.
209 // do it better, then remove.
210 static bool
211 always_immediate (const client *ns, const packet_type *pkt, const char *data, int len)
212 {
213 if (!(pkt->flags & (PF_COMMAND0 | PF_COMMAND6)))
214 return false;
215
216 if (!ns->pl || !ns->pl->ob || !ns->pl->ob->map)
217 return false;
218
219 if (pkt->flags & PF_COMMAND6)
220 {
221 data += 6;
222 len -= 6;
223 }
224
225 if (len > 4 && data [ 3] == ' ' && !strncmp (data, "say " , 4)) return true;
226 if (len > 5 && data [ 4] == ' ' && !strncmp (data, "chat " , 5)) return true;
227 if (len > 6 && data [ 5] == ' ' && !strncmp (data, "shout " , 6)) return true;
228 if (len > 8 && data [ 7] == ' ' && !strncmp (data, "suicide " , 8)) return true;
229 if (len > 18 && data [17] == ' ' && !strncmp (data, "accept-invitation ", 18)) return true;
230
231 if (len == 7 && !strcmp (data, "suicide")) return true;
232
233 return false;
234 }
235
236 void
237 client::execute (const packet_type *pkt, char *data, int datalen)
238 {
239 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
240 {
241 //TODO: only one format
242 if (pkt->flags & PF_PLAYER)
243 {
244 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
245 pl->need_updated_stats ();
246 }
247 else
248 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
249 }
250 else
251 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
252 }
253
254 bool
255 client::handle_packet ()
256 {
257 int pkt_len = next_packet ();
258
259 if (!pkt_len)
260 return false;
261 else if (pkt_len < 0)
262 {
263 LOG (llevError, "read error on player %s\n",
264 pl && pl->ob ? &pl->ob->name : "[anonymous]");
265 destroy ();
266 return false;
267 }
268
269 uint8_t save_byte = inbuf [pkt_len]; // rather ugly
270 inbuf [pkt_len] = 0; /* temporarily terminate buffer - useful for string data */
271
272 /* First, break out beginning word. There are at least
273 * a few commands that do not have any paremeters. If
274 * we get such a command, don't worry about trying
275 * to break it up.
276 */
277 int datalen;
278 char *data = strchr ((char *)inbuf + 2, ' ');
279
280 if (data)
281 {
282 *data++ = 0;
283 datalen = pkt_len - (data - (char *)inbuf);
284 }
285 else
286 {
287 data = (char *)inbuf + 2; // better read garbage than segfault
288 datalen = 0;
289 }
290
291 for (packet_type *pkt = packets; pkt < packets + array_length (packets); ++pkt)
292 if (!strcmp ((char *)inbuf + 2, pkt->name))
293 {
294 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
295 queue_command (pkt, data, datalen);
296 else
297 execute (pkt, data, datalen);
298
299 goto next_packet;
300 }
301
302 // If we get here, we didn't find a valid command.
303 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
304
305 next_packet:
306 inbuf [pkt_len] = save_byte; // rather ugly
307 skip_packet (pkt_len);
308
309 // input buffer has space again
310 socket_ev.poll (socket_ev.poll () | EV_READ);
311
312 return true;
313 }
314
315 void
316 client::inbuf_handle ()
317 {
318 if (!handle_packet ())
319 return;
320
321 while (handle_packet ())
322 ;
323
324 flush ();
325 }
326
327 // callback called when socket is either readable or writable
328 void
329 client::socket_cb (iow &w, int revents)
330 {
331 //TODO remove when we have better socket cleanup logic
332 if (destroyed ())
333 {
334 socket_ev.poll (0);
335 return;
336 }
337
338 if (revents & EV_WRITE)
339 {
340 write_outputbuffer ();
341
342 if (!outputbuffer.len)
343 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
344 }
345
346 if (revents & EV_READ)
347 {
348 int amount;
349 uint8 *rbuf;
350
351 if (ws_version)
352 {
353 if (ws_inbuf_len + 2048 > ws_inbuf_alloc)
354 ws_inbuf = (uint8 *)realloc (ws_inbuf, ws_inbuf_alloc += 4096);
355
356 rbuf = ws_inbuf;
357 amount = ws_inbuf_alloc - ws_inbuf_len;
358 }
359 else
360 {
361 rbuf = inbuf;
362 amount = sizeof (inbuf) - inbuf_len;
363 }
364
365 if (!amount)
366 {
367 // input buffer full
368 LOG (llevError, "input buffer overflow.");
369 destroy ();
370 return;
371 }
372
373 amount = read (fd, ws_inbuf + ws_inbuf_len, amount);
374
375 if (!amount)
376 {
377 destroy ();
378 return;
379 }
380 else if (amount < 0)
381 {
382 if (errno != EAGAIN && errno != EINTR)
383 {
384 LOG (llevError, "read error: %s\n", strerror (errno));
385 destroy ();
386 return;
387 }
388
389 // should not be here, normally
390 }
391
392 if (ws_version)
393 {
394 ws_inbuf_len += amount;
395
396 while (ws_inbuf_len)
397 {
398 if (ws_inbuf_len < 2 + 4) // 6 is minimum length: op, len, mask
399 break;
400
401 int d = 2;
402 int fin = ws_inbuf [0] & 0x80;
403 int op = ws_inbuf [0] & 0x0f;
404 int len = ws_inbuf [1] & 0x7f;
405
406 if (len == 126)
407 {
408 len = (ws_inbuf [2] << 8) | ws_inbuf [3];
409 d += 2;
410 }
411 else if (len == 127)
412 {
413 if (ws_inbuf_len < 2 + 8)
414 return;
415
416 // we don't do extra long frames, if a browser wants to send >2**32 bytes,
417 // there are bigger issues to fix.
418 len = (ws_inbuf [8] << 8) | ws_inbuf [9];
419 d += 8;
420 }
421
422 // we only continue if we have a complete frame
423 if (ws_inbuf_len < d + 4 + len)
424 return;
425
426 switch (op)
427 {
428 case 0: op = ws_inbuf_type; break; // continuation
429 case 1: ws_inbuf_type = 1; break; // utf-8
430 case 2: ws_inbuf_type = 2; break; // binary
431 }
432
433 if (len > sizeof (inbuf) - inbuf_len)
434 {
435 // input buffer full
436 LOG (llevError, "input buffer overflow (ws).");
437 destroy ();
438 return;
439 }
440
441 uint8 *buf = inbuf + inbuf_len + 2;
442
443 for (int i = 0; i < len; ++i)
444 buf [i] = ws_inbuf [d + 4 + i] ^ ws_inbuf [d + (i & 3)];
445
446 // remove frame
447 ws_inbuf_len -= d + 4 + len;
448 memmove (ws_inbuf, ws_inbuf + d + 4 + len, ws_inbuf_len);
449
450 switch (op)
451 {
452 case 1: // utf-8
453 // utf-8 encoded frames cannot have full length (MAXSOCKBUF) in all cases
454 // but we assume that these extra-long packets will be rare.
455 {
456 uint8 *a = buf;
457 uint8 *b = a;
458 uint8 *c = a + len;
459
460 for (; a < c; ++a, ++b)
461 {
462 *b = *a;
463
464 if (*a >= 0x80)
465 *b = (a [0] & 0x1f) << 6 | (a [1] & 0x3f), ++a;
466 }
467
468 len -= a - b;
469 }
470 /* FALLTHROUGH */
471 case 2: // binary
472 inbuf_len += len;
473
474 if (fin)
475 {
476 inbuf [0] = inbuf_len >> 8;
477 inbuf [1] = inbuf_len;
478
479 inbuf_len += 2;
480
481 inbuf_handle ();
482 }
483 break;
484
485 case 9: // ping
486 {
487 // send pong - we assume ping messages are <64k
488 // as we can't handle >10k at the moment anyway.
489 uint8 hdr [] = { 0x8a, 126, len >> 8, len };
490 send (hdr, sizeof (hdr));
491 send (inbuf + inbuf_len, len);
492 }
493 break;
494
495 case 10: // pong
496 break;
497
498 case 8: // close
499 default:
500 destroy ();
501 return;
502 }
503 }
504 }
505 else
506 {
507 inbuf_len += amount;
508 inbuf_handle ();
509 }
510 }
511 }
512
513 /*******************************************************************************
514 *
515 * Start of write related routines.
516 *
517 ******************************************************************************/
518
519 /**
520 * Adds data to a socket buffer for whatever reason.
521 *
522 * ns is the socket we are adding the data to, buf is the start of the
523 * data, and len is the number of bytes to add.
524 */
525 void
526 client::send (void *buf_, int len)
527 {
528 char *buf = (char *)buf_;
529
530 if (destroyed () || !buf)
531 return;
532
533 if (len + outputbuffer.len > SOCKETBUFSIZE)
534 {
535 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
536 // shutdown the socket, this is safer than destroying it immediately
537 // as lots of code in the callchain might still access the map etc.
538 shutdown (fd, SHUT_RDWR);
539 return;
540 }
541
542 int avail, end;
543
544 /* data + end is where we start putting the new data. The last byte
545 * currently in use is actually data + end -1
546 */
547 end = outputbuffer.start + outputbuffer.len;
548 /* The buffer is already in a wrapped state, so adjust end */
549 if (end >= SOCKETBUFSIZE)
550 end -= SOCKETBUFSIZE;
551
552 avail = SOCKETBUFSIZE - end;
553
554 /* We can all fit it behind the current data without wrapping */
555 if (avail >= len)
556 memcpy (outputbuffer.data + end, buf, len);
557 else
558 {
559 memcpy (outputbuffer.data + end, buf, avail);
560 memcpy (outputbuffer.data, buf + avail, len - avail);
561 }
562
563 outputbuffer.len += len;
564 }
565
566 /**
567 * Takes a string of data, and writes it out to the socket. A very handy
568 * shortcut function.
569 */
570 void
571 client::send_packet (packet &sl)
572 {
573 if (destroyed ())
574 return;
575
576 if (sl.length () > MAXSOCKBUF)
577 {
578 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
579 /* Almost certainly we've overflowed a buffer, so quit now to make
580 * it easier to debug.
581 */
582 abort ();
583 }
584
585 if (!sl.length ())
586 return;
587
588 if (ws_version == 8)
589 {
590 static uint8 buf [MAXSOCKBUF * 2 + 4];
591
592 uint8 *b = buf + 4;
593 for (uint8 *a = sl.buf_ + sl.hdrlen; a < sl.cur; ++a)
594 {
595 if (*a < 0x80)
596 *b++ = *a;
597 else
598 {
599 *b++ = 0xc0 | ((*a >> 6) & 0x1f);
600 *b++ = 0x80 | ( *a & 0x3f);
601 }
602 }
603
604 assert (b - buf < sizeof (buf));
605
606 int len = b - (buf + 4);
607
608 if (len < 126)
609 {
610 buf [2] = 0x81;
611 buf [3] = len;
612
613 send (buf + 2, len + 2);
614 }
615 else
616 {
617 buf [0] = 0x81;
618 buf [1] = 126;
619 buf [2] = len >> 8;
620 buf [3] = len;
621
622 send (buf, len + 4);
623 }
624 }
625 else if (ws_version == 13)
626 {
627 int len = sl.length ();
628
629 if (len < 126)
630 {
631 uint8 hdr [] = { 0x82, len };
632 send (hdr, sizeof (hdr));
633 }
634 else
635 {
636 uint8 hdr [] = { 0x82, 126, len >> 8, len };
637 send (hdr, sizeof (hdr));
638 }
639
640 send (sl.buf_ + sl.hdrlen, len);
641 }
642 else
643 {
644 assert (sl.hdrlen == 2);
645
646 sl.buf_ [0] = sl.length () >> 8;
647 sl.buf_ [1] = sl.length () ;
648
649 send (sl.buf_, sl.length () + sl.hdrlen);
650 }
651 }
652
653 void
654 client::send_packet (const char *buf, int len)
655 {
656 packet sl;
657
658 sl << data (buf, len);
659 send_packet (sl);
660 }
661
662 void
663 client::send_packet (const char *buf)
664 {
665 send_packet (buf, strlen (buf));
666 }
667
668 void
669 client::send_packet_printf (const char *format, ...)
670 {
671 packet sl;
672
673 va_list ap;
674 va_start (ap, format);
675 sl.vprintf (format, ap);
676 va_end (ap);
677
678 send_packet (sl);
679 }
680
681 void
682 client::send_msg (int color, const char *type, const char *msg)
683 {
684 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
685 {
686 LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
687 return;
688 }
689
690 int len = strlen (msg);
691
692 if (!(color & NDI_VERBATIM)
693 && (msg_is_special (msg)
694 || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128)))
695 cfperl_send_msg (this, color, type, msg);
696 else
697 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
698 }
699
700 void
701 client::send_drawinfo (const char *msg, int flags)
702 {
703 send_msg (flags, "log", msg);
704 }
705
706 /***********************************************************************
707 *
708 * packet functions/utilities
709 *
710 **********************************************************************/
711
712 packet::packet (const char *name)
713 {
714 reset ();
715
716 int len = strlen (name);
717 memcpy (cur, name, len); cur += len;
718 *cur++ = ' ';
719 }
720
721 packet &packet::operator <<(const ber32 v)
722 {
723 enum { maxlen = 32 / 7 + 1 };
724 uint8 buf[maxlen];
725 uint8 *p = buf + maxlen;
726 uint32 val = v.val;
727
728 *--p = val & 0x7F;
729
730 while (val > 0x7F)
731 {
732 val >>= 7;
733 *--p = (val & 0x7F) | 0x80;
734 }
735
736 return *this << data (p, buf + maxlen - p);
737 }
738
739 packet &packet::operator <<(const data &v)
740 {
741 if (room () < v.len)
742 reset ();
743 else
744 {
745 if (v.len)
746 {
747 memcpy (cur, v.ptr, v.len);
748 cur += v.len;
749 }
750 }
751
752 return *this;
753 }
754
755 packet &packet::operator <<(const data8 &v)
756 {
757 unsigned int len = min (v.len, 0x00FF);
758 return *this << uint8 (len) << data (v.ptr, len);
759 }
760
761 packet &packet::operator <<(const data16 &v)
762 {
763 unsigned int len = min (v.len, 0xFFFF);
764 return *this << uint16 (len) << data (v.ptr, len);
765 }
766
767 packet &packet::operator <<(const char *v)
768 {
769 return *this << data (v, strlen (v ? v : 0));
770 }
771
772 void
773 packet::vprintf (const char *format, va_list ap)
774 {
775 int size = room ();
776
777 int len = vsnprintf ((char *)cur, size, format, ap);
778
779 if (len >= size)
780 return reset ();
781
782 cur += len;
783 }
784