ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.72
Committed: Tue Oct 13 18:20:08 2009 UTC (14 years, 7 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-2_82
Changes since 1.71: +4 -1 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 /*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 1992,2007 Frank Tore Johansen
6 *
7 * Deliantra is free software: you can redistribute it and/or modify it under
8 * the terms of the Affero GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * 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 Affero GNU General Public License
18 * and the GNU General Public License along with this program. If not, see
19 * <http://www.gnu.org/licenses/>.
20 *
21 * The authors can be reached via e-mail to <support@deliantra.net>
22 */
23
24 using namespace std;
25
26 #include <global.h>
27 #include <sproto.h>
28 #include <cstdarg>
29
30 #if HAVE_TCP_INFO
31 # include <sys/types.h>
32 # include <sys/socket.h>
33 # include <netinet/in.h>
34 # include <netinet/tcp.h>
35 #endif
36
37 // force a packet when idle for more than this many seconds,
38 // forcing an ack regularly.
39 #define IDLE_PING 2.
40
41 void
42 client::flush ()
43 {
44 if (destroyed ())
45 return;
46
47 /**
48 * Writes data to socket.
49 *
50 * When the socket is clear to write, and we have backlogged data, this
51 * is called to write it out.
52 */
53
54 // write a nop to the socket at least every IDLE_NOP seconds.
55 if (!outputbuffer.len)
56 {
57 if (last_send + IDLE_PING <= NOW && pl && pl->active)
58 {
59 // this is a bit ugly, but map1/map1a seem to be the only
60 // nop'able commands and they are quite small.
61 packet sl (mapmode == Map1Cmd ? "map1" : "map1a");
62 send_packet (sl);
63 }
64 else
65 return;
66 }
67
68 if (socket_ev.poll () & EV_WRITE)
69 return;
70
71 last_send = NOW;
72 write_outputbuffer ();
73 }
74
75 void
76 client::write_outputbuffer ()
77 {
78 while (outputbuffer.len)
79 {
80 int res = write (fd, outputbuffer.data + outputbuffer.start,
81 min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
82
83 if (res > 0)
84 {
85 outputbuffer.start += res;
86 /* wrap back to start of buffer */
87 if (outputbuffer.start == SOCKETBUFSIZE)
88 outputbuffer.start = 0;
89
90 outputbuffer.len -= res;
91 }
92 else if (res == 0)
93 {
94 LOG (llevError, "socket write failed, connection closed.\n");
95 destroy ();
96 return;
97 }
98 else if (errno == EINTR)
99 {
100 // just retry
101 }
102 else if (errno == EAGAIN)
103 {
104 // delay till ready
105 socket_ev.poll (socket_ev.poll () | EV_WRITE);
106 socket_ev.start ();
107 return;
108 }
109 else
110 {
111 LOG (llevError, "socket write failed: %s\n", strerror (errno));
112 destroy ();
113 return;
114 }
115 }
116
117 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
118 }
119
120 /******************************************************************************
121 *
122 * Start of read routines.
123 *
124 ******************************************************************************/
125
126 int
127 client::next_packet ()
128 {
129 if (inbuf_len >= 2)
130 {
131 int pkt_len = (inbuf [0] << 8) | inbuf [1];
132
133 if (inbuf_len >= 2 + pkt_len)
134 return 2 + pkt_len;
135
136 if (inbuf_len == sizeof (inbuf))
137 {
138 send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED | NDI_REPLY);
139 destroy ();
140 return -1;
141 }
142 }
143
144 return 0;
145 }
146
147 void
148 client::skip_packet (int len)
149 {
150 inbuf_len -= len;
151 memmove (inbuf, inbuf + len, inbuf_len);
152 }
153
154 /*****************************************************************************
155 * Start of command dispatch area.
156 * The commands here are protocol commands.
157 ****************************************************************************/
158
159 // SocketCommand, PlayingCommand, should not exist with those ugly casts
160 #define SC(cb) (void *)static_cast<void (*)(char *, int, client *)>(cb),
161 #define PC(cb) (void *)static_cast<void (*)(char *, int, player *)>(cb), PF_PLAYER |
162
163 /**
164 * Dispatch table for the server.
165 */
166 static struct packet_type packets[] = {
167 {"ncom", PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 },
168 {"command", PC(PlayerCmd) PF_PLAYING | PF_COMMAND0 },
169
170 {"examine", PC(ExamineCmd) PF_PLAYING },
171 {"ex", PC(ExCmd) PF_PLAYING },
172 {"apply", PC(ApplyCmd) PF_PLAYING },
173 {"lookat", PC(LookAt) PF_PLAYING },
174 {"lock", PC(LockItem) PF_PLAYING },
175 {"mark", PC(MarkItem) PF_PLAYING },
176 {"move", PC(MoveCmd) PF_PLAYING },
177 {"ext", PC(ExtCmd) 0 }, // CF+
178 {"mapredraw", PC(MapRedrawCmd) 0 },
179 {"mapinfo", PC(MapInfoCmd) 0 }, // CF+
180
181 {"reply", SC(ReplyCmd) 0 },
182 {"exti", SC(ExtiCmd) 0 }, // CF+
183 {"addme", SC(AddMeCmd) 0 },
184 {"askface", SC(AskFaceCmd) 0 },
185 {"requestinfo", SC(RequestInfo) 0 },
186 {"setsound", SC(SetSound) 0 },
187 {"setup", SC(SetUp) 0 },
188 {"version", SC(VersionCmd) 0 },
189 {"toggleextendedtext", SC(ToggleExtendedText) 0 }, /*Added: tchize */
190 };
191
192 bool
193 client::may_execute (const packet_type *pkt) const
194 {
195 return (!(pkt->flags & PF_PLAYER) || pl)
196 && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
197 }
198
199 // HACK: some commands currently should be executed
200 // even when the player is frozen. this hack detects
201 // those commands. it should be folded into may_execute,
202 // but kept seperate to emphasise the hack aspect, i.e.
203 // do it better, then remove.
204 static bool
205 always_immediate (const client *ns, const packet_type *pkt, const char *data, int len)
206 {
207 if (!(pkt->flags & (PF_COMMAND0 | PF_COMMAND6)))
208 return false;
209
210 if (!ns->pl || !ns->pl->ob || !ns->pl->ob->map)
211 return false;
212
213 if (pkt->flags & PF_COMMAND6)
214 {
215 data += 6;
216 len -= 6;
217 }
218
219 if (len > 4 && data [ 3] == ' ' && !strncmp (data, "say " , 4)) return true;
220 if (len > 5 && data [ 4] == ' ' && !strncmp (data, "chat " , 5)) return true;
221 if (len > 6 && data [ 5] == ' ' && !strncmp (data, "shout " , 6)) return true;
222 if (len > 8 && data [ 7] == ' ' && !strncmp (data, "suicide " , 8)) return true;
223 if (len > 18 && data [17] == ' ' && !strncmp (data, "accept-invitation ", 18)) return true;
224
225 if (len == 7 && !strcmp (data, "suicide")) return true;
226
227 return false;
228 }
229
230 void
231 client::execute (const packet_type *pkt, char *data, int datalen)
232 {
233 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
234 {
235 //TODO: only one format
236 if (pkt->flags & PF_PLAYER)
237 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
238 else
239 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
240 }
241 else
242 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
243 }
244
245 bool
246 client::handle_packet ()
247 {
248 int pkt_len = next_packet ();
249
250 if (!pkt_len)
251 return false;
252 else if (pkt_len < 0)
253 {
254 LOG (llevError, "read error on player %s\n",
255 pl && pl->ob ? &pl->ob->name : "[anonymous]");
256 destroy ();
257 return false;
258 }
259
260 uint8_t save_byte = inbuf [pkt_len]; // rather ugly
261 inbuf [pkt_len] = 0; /* temporarily terminate buffer - useful for string data */
262
263 /* First, break out beginning word. There are at least
264 * a few commands that do not have any paremeters. If
265 * we get such a command, don't worry about trying
266 * to break it up.
267 */
268 int datalen;
269 char *data = strchr ((char *)inbuf + 2, ' ');
270
271 if (data)
272 {
273 *data++ = 0;
274 datalen = pkt_len - (data - (char *)inbuf);
275 }
276 else
277 {
278 data = (char *)inbuf + 2; // better read garbage than segfault
279 datalen = 0;
280 }
281
282 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
283 if (!strcmp ((char *)inbuf + 2, pkt->name))
284 {
285 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
286 queue_command (pkt, data, datalen);
287 else
288 execute (pkt, data, datalen);
289
290 goto next_packet;
291 }
292
293 // If we get here, we didn't find a valid command.
294 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
295
296 next_packet:
297 inbuf [pkt_len] = save_byte; // rather ugly
298 skip_packet (pkt_len);
299
300 // input buffer has space again
301 socket_ev.poll (socket_ev.poll () | EV_READ);
302
303 return true;
304 }
305
306 // callback called when socket is either readable or writable
307 void
308 client::socket_cb (iow &w, int revents)
309 {
310 //TODO remove when we have better socket cleanup logic
311 if (destroyed ())
312 {
313 socket_ev.poll (0);
314 return;
315 }
316
317 if (revents & EV_WRITE)
318 {
319 write_outputbuffer ();
320
321 if (!outputbuffer.len)
322 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
323 }
324
325 if (revents & EV_READ)
326 {
327 //TODO: rate-limit tcp connection in better ways, important
328
329 int amount = sizeof (inbuf) - inbuf_len;
330
331 if (!amount)
332 {
333 // input buffer full
334 socket_ev.poll (socket_ev.poll () & ~EV_READ);
335 return;
336 }
337
338 amount = read (fd, inbuf + inbuf_len, amount);
339
340 if (!amount)
341 {
342 destroy ();
343 return;
344 }
345 else if (amount < 0)
346 {
347 if (errno != EAGAIN && errno != EINTR)
348 {
349 LOG (llevError, "read error: %s\n", strerror (errno));
350 destroy ();
351 return;
352 }
353
354 // should not be here, normally
355 }
356 else
357 {
358 inbuf_len += amount;
359
360 if (handle_packet ())
361 {
362 while (handle_packet ())
363 ;
364
365 flush ();
366 }
367 }
368 }
369 }
370
371 /*******************************************************************************
372 *
373 * Start of write related routines.
374 *
375 ******************************************************************************/
376
377 /**
378 * Adds data to a socket buffer for whatever reason.
379 *
380 * ns is the socket we are adding the data to, buf is the start of the
381 * data, and len is the number of bytes to add.
382 */
383 void
384 client::send (void *buf_, int len)
385 {
386 char *buf = (char *)buf_;
387
388 if (destroyed () || !buf)
389 return;
390
391 if (len + outputbuffer.len > SOCKETBUFSIZE)
392 {
393 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
394 // shutdown the socket, this is safer than destroying it immediately
395 // as lots of code in the callchain might still access the map etc.
396 shutdown (fd, SHUT_RDWR);
397 return;
398 }
399
400 int avail, end;
401
402 /* data + end is where we start putting the new data. The last byte
403 * currently in use is actually data + end -1
404 */
405 end = outputbuffer.start + outputbuffer.len;
406 /* The buffer is already in a wrapped state, so adjust end */
407 if (end >= SOCKETBUFSIZE)
408 end -= SOCKETBUFSIZE;
409
410 avail = SOCKETBUFSIZE - end;
411
412 /* We can all fit it behind the current data without wrapping */
413 if (avail >= len)
414 memcpy (outputbuffer.data + end, buf, len);
415 else
416 {
417 memcpy (outputbuffer.data + end, buf, avail);
418 memcpy (outputbuffer.data, buf + avail, len - avail);
419 }
420
421 outputbuffer.len += len;
422 }
423
424 /**
425 * Takes a string of data, and writes it out to the socket. A very handy
426 * shortcut function.
427 */
428 void
429 client::send_packet (packet &sl)
430 {
431 if (destroyed ())
432 return;
433
434 if (sl.length () > MAXSOCKBUF)
435 {
436 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
437 /* Almost certainly we've overflowed a buffer, so quit now to make
438 * it easier to debug.
439 */
440 abort ();
441 }
442
443 if (!sl.length ())
444 return;
445
446 assert (sl.hdrlen == 2);
447
448 sl.buf_ [0] = sl.length () >> 8;
449 sl.buf_ [1] = sl.length () ;
450
451 send (sl.buf_, sl.length () + sl.hdrlen);
452 }
453
454 void
455 client::send_packet (const char *buf, int len)
456 {
457 packet sl;
458
459 sl << data (buf, len);
460 send_packet (sl);
461 }
462
463 void
464 client::send_packet (const char *buf)
465 {
466 send_packet (buf, strlen (buf));
467 }
468
469 void
470 client::send_packet_printf (const char *format, ...)
471 {
472 packet sl;
473
474 va_list ap;
475 va_start (ap, format);
476 sl.vprintf (format, ap);
477 va_end (ap);
478
479 send_packet (sl);
480 }
481
482 void
483 client::send_msg (int color, const char *type, const char *msg)
484 {
485 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
486 {
487 LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
488 return;
489 }
490
491 int len = strlen (msg);
492
493 if (!(color & NDI_VERBATIM)
494 && (msg_is_special (msg)
495 || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128)))
496 cfperl_send_msg (this, color, type, msg);
497 else
498 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
499 }
500
501 void
502 client::send_drawinfo (const char *msg, int flags)
503 {
504 send_msg (flags, "log", msg);
505 }
506
507 /***********************************************************************
508 *
509 * packet functions/utilities
510 *
511 **********************************************************************/
512
513 packet::packet (const char *name)
514 {
515 reset ();
516
517 int len = strlen (name);
518 memcpy (cur, name, len); cur += len;
519 *cur++ = ' ';
520 }
521
522 packet &packet::operator <<(const ber32 v)
523 {
524 enum { maxlen = 32 / 7 + 1};
525 uint8 buf[maxlen];
526 uint8 *p = buf + maxlen;
527 uint32 val = v.val;
528
529 *--p = val & 0x7F;
530
531 while (val > 0x7F)
532 {
533 val >>= 7;
534 *--p = (val & 0x7F) | 0x80;
535 }
536
537 return *this << data (p, buf + maxlen - p);
538 }
539
540 packet &packet::operator <<(const data &v)
541 {
542 if (room () < v.len)
543 reset ();
544 else
545 {
546 if (v.len)
547 {
548 memcpy (cur, v.ptr, v.len);
549 cur += v.len;
550 }
551 }
552
553 return *this;
554 }
555
556 packet &packet::operator <<(const data8 &v)
557 {
558 unsigned int len = min (v.len, 0x00FF);
559 return *this << uint8 (len) << data (v.ptr, len);
560 }
561
562 packet &packet::operator <<(const data16 &v)
563 {
564 unsigned int len = min (v.len, 0xFFFF);
565 return *this << uint16 (len) << data (v.ptr, len);
566 }
567
568 packet &packet::operator <<(const char *v)
569 {
570 return *this << data (v, strlen (v ? v : 0));
571 }
572
573 void
574 packet::vprintf (const char *format, va_list ap)
575 {
576 int size = room ();
577
578 int len = vsnprintf ((char *)cur, size, format, ap);
579
580 if (len >= size)
581 return reset ();
582
583 cur += len;
584 }
585