ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.73
Committed: Tue Nov 3 23:44:21 2009 UTC (14 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-2_90
Changes since 1.72: +1 -2 lines
Log Message:
tighten copyright statements for files containing no gpl code whatsoever anymore

File Contents

# Content
1 /*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008,2009 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_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 {"setsound", SC(SetSound) 0 },
186 {"setup", SC(SetUp) 0 },
187 {"version", SC(VersionCmd) 0 },
188 {"toggleextendedtext", SC(ToggleExtendedText) 0 }, /*Added: tchize */
189 };
190
191 bool
192 client::may_execute (const packet_type *pkt) const
193 {
194 return (!(pkt->flags & PF_PLAYER) || pl)
195 && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
196 }
197
198 // HACK: some commands currently should be executed
199 // even when the player is frozen. this hack detects
200 // those commands. it should be folded into may_execute,
201 // but kept seperate to emphasise the hack aspect, i.e.
202 // do it better, then remove.
203 static bool
204 always_immediate (const client *ns, const packet_type *pkt, const char *data, int len)
205 {
206 if (!(pkt->flags & (PF_COMMAND0 | PF_COMMAND6)))
207 return false;
208
209 if (!ns->pl || !ns->pl->ob || !ns->pl->ob->map)
210 return false;
211
212 if (pkt->flags & PF_COMMAND6)
213 {
214 data += 6;
215 len -= 6;
216 }
217
218 if (len > 4 && data [ 3] == ' ' && !strncmp (data, "say " , 4)) return true;
219 if (len > 5 && data [ 4] == ' ' && !strncmp (data, "chat " , 5)) return true;
220 if (len > 6 && data [ 5] == ' ' && !strncmp (data, "shout " , 6)) return true;
221 if (len > 8 && data [ 7] == ' ' && !strncmp (data, "suicide " , 8)) return true;
222 if (len > 18 && data [17] == ' ' && !strncmp (data, "accept-invitation ", 18)) return true;
223
224 if (len == 7 && !strcmp (data, "suicide")) return true;
225
226 return false;
227 }
228
229 void
230 client::execute (const packet_type *pkt, char *data, int datalen)
231 {
232 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
233 {
234 //TODO: only one format
235 if (pkt->flags & PF_PLAYER)
236 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
237 else
238 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
239 }
240 else
241 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
242 }
243
244 bool
245 client::handle_packet ()
246 {
247 int pkt_len = next_packet ();
248
249 if (!pkt_len)
250 return false;
251 else if (pkt_len < 0)
252 {
253 LOG (llevError, "read error on player %s\n",
254 pl && pl->ob ? &pl->ob->name : "[anonymous]");
255 destroy ();
256 return false;
257 }
258
259 uint8_t save_byte = inbuf [pkt_len]; // rather ugly
260 inbuf [pkt_len] = 0; /* temporarily 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
295 next_packet:
296 inbuf [pkt_len] = save_byte; // rather ugly
297 skip_packet (pkt_len);
298
299 // input buffer has space again
300 socket_ev.poll (socket_ev.poll () | EV_READ);
301
302 return true;
303 }
304
305 // callback called when socket is either readable or writable
306 void
307 client::socket_cb (iow &w, int revents)
308 {
309 //TODO remove when we have better socket cleanup logic
310 if (destroyed ())
311 {
312 socket_ev.poll (0);
313 return;
314 }
315
316 if (revents & EV_WRITE)
317 {
318 write_outputbuffer ();
319
320 if (!outputbuffer.len)
321 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
322 }
323
324 if (revents & EV_READ)
325 {
326 //TODO: rate-limit tcp connection in better ways, important
327
328 int amount = sizeof (inbuf) - inbuf_len;
329
330 if (!amount)
331 {
332 // input buffer full
333 socket_ev.poll (socket_ev.poll () & ~EV_READ);
334 return;
335 }
336
337 amount = read (fd, inbuf + inbuf_len, amount);
338
339 if (!amount)
340 {
341 destroy ();
342 return;
343 }
344 else if (amount < 0)
345 {
346 if (errno != EAGAIN && errno != EINTR)
347 {
348 LOG (llevError, "read error: %s\n", strerror (errno));
349 destroy ();
350 return;
351 }
352
353 // should not be here, normally
354 }
355 else
356 {
357 inbuf_len += amount;
358
359 if (handle_packet ())
360 {
361 while (handle_packet ())
362 ;
363
364 flush ();
365 }
366 }
367 }
368 }
369
370 /*******************************************************************************
371 *
372 * Start of write related routines.
373 *
374 ******************************************************************************/
375
376 /**
377 * Adds data to a socket buffer for whatever reason.
378 *
379 * ns is the socket we are adding the data to, buf is the start of the
380 * data, and len is the number of bytes to add.
381 */
382 void
383 client::send (void *buf_, int len)
384 {
385 char *buf = (char *)buf_;
386
387 if (destroyed () || !buf)
388 return;
389
390 if (len + outputbuffer.len > SOCKETBUFSIZE)
391 {
392 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
393 // shutdown the socket, this is safer than destroying it immediately
394 // as lots of code in the callchain might still access the map etc.
395 shutdown (fd, SHUT_RDWR);
396 return;
397 }
398
399 int avail, end;
400
401 /* data + end is where we start putting the new data. The last byte
402 * currently in use is actually data + end -1
403 */
404 end = outputbuffer.start + outputbuffer.len;
405 /* The buffer is already in a wrapped state, so adjust end */
406 if (end >= SOCKETBUFSIZE)
407 end -= SOCKETBUFSIZE;
408
409 avail = SOCKETBUFSIZE - end;
410
411 /* We can all fit it behind the current data without wrapping */
412 if (avail >= len)
413 memcpy (outputbuffer.data + end, buf, len);
414 else
415 {
416 memcpy (outputbuffer.data + end, buf, avail);
417 memcpy (outputbuffer.data, buf + avail, len - avail);
418 }
419
420 outputbuffer.len += len;
421 }
422
423 /**
424 * Takes a string of data, and writes it out to the socket. A very handy
425 * shortcut function.
426 */
427 void
428 client::send_packet (packet &sl)
429 {
430 if (destroyed ())
431 return;
432
433 if (sl.length () > MAXSOCKBUF)
434 {
435 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
436 /* Almost certainly we've overflowed a buffer, so quit now to make
437 * it easier to debug.
438 */
439 abort ();
440 }
441
442 if (!sl.length ())
443 return;
444
445 assert (sl.hdrlen == 2);
446
447 sl.buf_ [0] = sl.length () >> 8;
448 sl.buf_ [1] = sl.length () ;
449
450 send (sl.buf_, sl.length () + sl.hdrlen);
451 }
452
453 void
454 client::send_packet (const char *buf, int len)
455 {
456 packet sl;
457
458 sl << data (buf, len);
459 send_packet (sl);
460 }
461
462 void
463 client::send_packet (const char *buf)
464 {
465 send_packet (buf, strlen (buf));
466 }
467
468 void
469 client::send_packet_printf (const char *format, ...)
470 {
471 packet sl;
472
473 va_list ap;
474 va_start (ap, format);
475 sl.vprintf (format, ap);
476 va_end (ap);
477
478 send_packet (sl);
479 }
480
481 void
482 client::send_msg (int color, const char *type, const char *msg)
483 {
484 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
485 {
486 LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
487 return;
488 }
489
490 int len = strlen (msg);
491
492 if (!(color & NDI_VERBATIM)
493 && (msg_is_special (msg)
494 || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128)))
495 cfperl_send_msg (this, color, type, msg);
496 else
497 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
498 }
499
500 void
501 client::send_drawinfo (const char *msg, int flags)
502 {
503 send_msg (flags, "log", msg);
504 }
505
506 /***********************************************************************
507 *
508 * packet functions/utilities
509 *
510 **********************************************************************/
511
512 packet::packet (const char *name)
513 {
514 reset ();
515
516 int len = strlen (name);
517 memcpy (cur, name, len); cur += len;
518 *cur++ = ' ';
519 }
520
521 packet &packet::operator <<(const ber32 v)
522 {
523 enum { maxlen = 32 / 7 + 1};
524 uint8 buf[maxlen];
525 uint8 *p = buf + maxlen;
526 uint32 val = v.val;
527
528 *--p = val & 0x7F;
529
530 while (val > 0x7F)
531 {
532 val >>= 7;
533 *--p = (val & 0x7F) | 0x80;
534 }
535
536 return *this << data (p, buf + maxlen - p);
537 }
538
539 packet &packet::operator <<(const data &v)
540 {
541 if (room () < v.len)
542 reset ();
543 else
544 {
545 if (v.len)
546 {
547 memcpy (cur, v.ptr, v.len);
548 cur += v.len;
549 }
550 }
551
552 return *this;
553 }
554
555 packet &packet::operator <<(const data8 &v)
556 {
557 unsigned int len = min (v.len, 0x00FF);
558 return *this << uint8 (len) << data (v.ptr, len);
559 }
560
561 packet &packet::operator <<(const data16 &v)
562 {
563 unsigned int len = min (v.len, 0xFFFF);
564 return *this << uint16 (len) << data (v.ptr, len);
565 }
566
567 packet &packet::operator <<(const char *v)
568 {
569 return *this << data (v, strlen (v ? v : 0));
570 }
571
572 void
573 packet::vprintf (const char *format, va_list ap)
574 {
575 int size = room ();
576
577 int len = vsnprintf ((char *)cur, size, format, ap);
578
579 if (len >= size)
580 return reset ();
581
582 cur += len;
583 }
584