ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.64
Committed: Tue May 6 16:55:26 2008 UTC (16 years ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.63: +1 -1 lines
Log Message:
update copyright

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
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your 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 GNU General Public License
18 * along with this program. If not, see <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_NOP seconds.
54 if (!outputbuffer.len)
55 {
56 if (last_send + IDLE_PING <= NOW && pl && pl->active)
57 {
58 // this is a bit ugly, but map1/map1a seem to be the only
59 // nop'able commands and they are quite small.
60 packet sl (mapmode == Map1Cmd ? "map1" : "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 /**
163 * Dispatch table for the server.
164 */
165 static struct packet_type packets[] = {
166 {"ncom", PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 },
167 {"command", PC(PlayerCmd) PF_PLAYING | PF_COMMAND0 },
168
169 {"examine", PC(ExamineCmd) PF_PLAYING },
170 {"ex", PC(ExCmd) PF_PLAYING },
171 {"apply", PC(ApplyCmd) PF_PLAYING },
172 {"lookat", PC(LookAt) PF_PLAYING },
173 {"lock", PC(LockItem) PF_PLAYING },
174 {"mark", PC(MarkItem) PF_PLAYING },
175 {"move", PC(MoveCmd) PF_PLAYING },
176 {"ext", PC(ExtCmd) 0 }, // CF+
177 {"mapredraw", PC(MapRedrawCmd) 0 },
178 {"mapinfo", PC(MapInfoCmd) 0 }, // CF+
179
180 {"reply", SC(ReplyCmd) 0 },
181 {"exti", SC(ExtiCmd) 0 }, // CF+
182 {"addme", SC(AddMeCmd) 0 },
183 {"askface", SC(AskFaceCmd) 0 },
184 {"requestinfo", SC(RequestInfo) 0 },
185 {"setfacemode", SC(SetFaceMode) 0 },
186 {"setsound", SC(SetSound) 0 },
187 {"setup", SC(SetUp) 0 },
188 {"version", SC(VersionCmd) 0 },
189 {"toggleextendedinfos", SC(ToggleExtendedInfos) 0 }, /*Added: tchize */
190 {"toggleextendedtext", SC(ToggleExtendedText) 0 }, /*Added: tchize */
191 {"asksmooth", SC(AskSmooth) 0 }, /*Added: tchize (smoothing technologies) */
192 };
193
194 bool
195 client::may_execute (const packet_type *pkt) const
196 {
197 return (!(pkt->flags & PF_PLAYER) || pl)
198 && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
199 }
200
201 // HACK: some commands currently should be executed
202 // even when the player is frozen. this hack detects
203 // those commands. it should be folded into may_execute,
204 // but kept seperate to emphasise the hack aspect, i.e.
205 // do it better, then remove.
206 static bool
207 always_immediate (const client *ns, const packet_type *pkt, const char *data, int len)
208 {
209 if (!(pkt->flags & (PF_COMMAND0 | PF_COMMAND6)))
210 return false;
211
212 if (!ns->pl || !ns->pl->ob || !ns->pl->ob->map)
213 return false;
214
215 if (pkt->flags & PF_COMMAND6)
216 {
217 data += 6;
218 len -= 6;
219 }
220
221 if (len > 4 && data [3] == ' ' && !strncmp (data, "say " , 4)) return true;
222 if (len > 5 && data [4] == ' ' && !strncmp (data, "chat " , 5)) return true;
223 if (len > 6 && data [5] == ' ' && !strncmp (data, "shout ", 6)) 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 inbuf [pkt_len] = 0; /* Terminate buffer - useful for string data */
261
262 /* First, break out beginning word. There are at least
263 * a few commands that do not have any paremeters. If
264 * we get such a command, don't worry about trying
265 * to break it up.
266 */
267 int datalen;
268 char *data = strchr ((char *)inbuf + 2, ' ');
269
270 if (data)
271 {
272 *data++ = 0;
273 datalen = pkt_len - (data - (char *)inbuf);
274 }
275 else
276 {
277 data = (char *)inbuf + 2; // better read garbage than segfault
278 datalen = 0;
279 }
280
281 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
282 if (!strcmp ((char *)inbuf + 2, pkt->name))
283 {
284 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
285 queue_command (pkt, data, datalen);
286 else
287 execute (pkt, data, datalen);
288
289 goto next_packet;
290 }
291
292 // If we get here, we didn't find a valid command.
293 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
294 next_packet:
295 skip_packet (pkt_len);
296
297 // input buffer has space again
298 socket_ev.poll (socket_ev.poll () | EV_READ);
299
300 return true;
301 }
302
303 // callback called when socket is either readable or writable
304 void
305 client::socket_cb (iow &w, int revents)
306 {
307 //TODO remove when we have better socket cleanup logic
308 if (destroyed ())
309 {
310 socket_ev.poll (0);
311 return;
312 }
313
314 if (revents & EV_WRITE)
315 {
316 write_outputbuffer ();
317
318 if (!outputbuffer.len)
319 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
320 }
321
322 if (revents & EV_READ)
323 {
324 //TODO: rate-limit tcp connection in better ways, important
325
326 int amount = sizeof (inbuf) - inbuf_len;
327
328 if (!amount)
329 {
330 // input buffer full
331 socket_ev.poll (socket_ev.poll () & ~EV_READ);
332 return;
333 }
334
335 amount = read (fd, inbuf + inbuf_len, amount);
336
337 if (!amount)
338 {
339 destroy ();
340 return;
341 }
342 else if (amount < 0)
343 {
344 if (errno != EAGAIN && errno != EINTR)
345 {
346 LOG (llevError, "read error: %s\n", strerror (errno));
347 destroy ();
348 return;
349 }
350
351 // should not be here, normally
352 }
353 else
354 {
355 inbuf_len += amount;
356
357 if (handle_packet ())
358 {
359 while (handle_packet ())
360 ;
361
362 flush ();
363 }
364 }
365 }
366 }
367
368 /*******************************************************************************
369 *
370 * Start of write related routines.
371 *
372 ******************************************************************************/
373
374 /**
375 * Adds data to a socket buffer for whatever reason.
376 *
377 * ns is the socket we are adding the data to, buf is the start of the
378 * data, and len is the number of bytes to add.
379 */
380 void
381 client::send (void *buf_, int len)
382 {
383 char *buf = (char *)buf_;
384
385 if (destroyed () || !buf)
386 return;
387
388 if (len + outputbuffer.len > SOCKETBUFSIZE)
389 {
390 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
391 // shutdown the socket, this is safer than destroying it immediately
392 // as lots of code in the callchain might still access the map etc.
393 shutdown (fd, SHUT_RDWR);
394 return;
395 }
396
397 int avail, end;
398
399 /* data + end is where we start putting the new data. The last byte
400 * currently in use is actually data + end -1
401 */
402 end = outputbuffer.start + outputbuffer.len;
403 /* The buffer is already in a wrapped state, so adjust end */
404 if (end >= SOCKETBUFSIZE)
405 end -= SOCKETBUFSIZE;
406
407 avail = SOCKETBUFSIZE - end;
408
409 /* We can all fit it behind the current data without wrapping */
410 if (avail >= len)
411 memcpy (outputbuffer.data + end, buf, len);
412 else
413 {
414 memcpy (outputbuffer.data + end, buf, avail);
415 memcpy (outputbuffer.data, buf + avail, len - avail);
416 }
417
418 outputbuffer.len += len;
419 }
420
421 /**
422 * Takes a string of data, and writes it out to the socket. A very handy
423 * shortcut function.
424 */
425 void
426 client::send_packet (packet &sl)
427 {
428 if (destroyed ())
429 return;
430
431 if (sl.length () > MAXSOCKBUF)
432 {
433 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
434 /* Almost certainly we've overflowed a buffer, so quit now to make
435 * it easier to debug.
436 */
437 abort ();
438 }
439
440 if (!sl.length ())
441 return;
442
443 assert (sl.hdrlen == 2);
444
445 sl.buf_ [0] = sl.length () >> 8;
446 sl.buf_ [1] = sl.length () ;
447
448 send (sl.buf_, sl.length () + sl.hdrlen);
449 }
450
451 void
452 client::send_packet (const char *buf, int len)
453 {
454 packet sl;
455
456 sl << data (buf, len);
457 send_packet (sl);
458 }
459
460 void
461 client::send_packet (const char *buf)
462 {
463 send_packet (buf, strlen (buf));
464 }
465
466 void
467 client::send_packet_printf (const char *format, ...)
468 {
469 packet sl;
470
471 va_list ap;
472 va_start (ap, format);
473 sl.vprintf (format, ap);
474 va_end (ap);
475
476 send_packet (sl);
477 }
478
479 // returns true when the message needs special (read: perl) treatment
480 static bool
481 msg_is_special (const char *msg)
482 {
483 return msg [strcspn (msg, "<[&\n")];
484 }
485
486 void
487 client::send_msg (int color, const char *type, const char *msg)
488 {
489 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
490 {
491 LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
492 return;
493 }
494
495 int len = strlen (msg);
496
497 if (msg_is_special (msg) || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128))
498 cfperl_send_msg (this, color, type, msg);
499 else if (can_msg)
500 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
501 else if (color < 0)
502 return; // client cannot handle this
503 else
504 send_packet_printf ("drawinfo %d %s", color & NDI_COLOR_MASK, msg);
505 }
506
507 void
508 client::send_drawinfo (const char *msg, int flags)
509 {
510 send_msg (flags, "log", msg);
511 }
512
513 /***********************************************************************
514 *
515 * packet functions/utilities
516 *
517 **********************************************************************/
518
519 packet::packet (const char *name)
520 {
521 reset ();
522
523 int len = strlen (name);
524 memcpy (cur, name, len); cur += len;
525 *cur++ = ' ';
526 }
527
528 packet &packet::operator <<(const ber32 v)
529 {
530 enum { maxlen = 32 / 7 + 1};
531 uint8 buf[maxlen];
532 uint8 *p = buf + maxlen;
533 uint32 val = v.val;
534
535 *--p = val & 0x7F;
536
537 while (val > 0x7F)
538 {
539 val >>= 7;
540 *--p = (val & 0x7F) | 0x80;
541 }
542
543 return *this << data (p, buf + maxlen - p);
544 }
545
546 packet &packet::operator <<(const data &v)
547 {
548 if (room () < v.len)
549 reset ();
550 else
551 {
552 if (v.len)
553 {
554 memcpy (cur, v.ptr, v.len);
555 cur += v.len;
556 }
557 }
558
559 return *this;
560 }
561
562 packet &packet::operator <<(const data8 &v)
563 {
564 unsigned int len = min (v.len, 0x00FF);
565 return *this << uint8 (len) << data (v.ptr, len);
566 }
567
568 packet &packet::operator <<(const data16 &v)
569 {
570 unsigned int len = min (v.len, 0xFFFF);
571 return *this << uint16 (len) << data (v.ptr, len);
572 }
573
574 packet &packet::operator <<(const char *v)
575 {
576 return *this << data (v, strlen (v ? v : 0));
577 }
578
579 void
580 packet::vprintf (const char *format, va_list ap)
581 {
582 int size = room ();
583
584 int len = vsnprintf ((char *)cur, size, format, ap);
585
586 if (len >= size)
587 return reset ();
588
589 cur += len;
590 }
591