ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.68
Committed: Sat Dec 27 01:25:00 2008 UTC (15 years, 4 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.67: +0 -2 lines
Log Message:
gcfclient removal

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 {"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
222 if (len == 7 && !strcmp (data, "suicide")) return true;
223
224 return false;
225 }
226
227 void
228 client::execute (const packet_type *pkt, char *data, int datalen)
229 {
230 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
231 {
232 //TODO: only one format
233 if (pkt->flags & PF_PLAYER)
234 ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
235 else
236 ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
237 }
238 else
239 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
240 }
241
242 bool
243 client::handle_packet ()
244 {
245 int pkt_len = next_packet ();
246
247 if (!pkt_len)
248 return false;
249 else if (pkt_len < 0)
250 {
251 LOG (llevError, "read error on player %s\n",
252 pl && pl->ob ? &pl->ob->name : "[anonymous]");
253 destroy ();
254 return false;
255 }
256
257 inbuf [pkt_len] = 0; /* Terminate buffer - useful for string data */
258
259 /* First, break out beginning word. There are at least
260 * a few commands that do not have any paremeters. If
261 * we get such a command, don't worry about trying
262 * to break it up.
263 */
264 int datalen;
265 char *data = strchr ((char *)inbuf + 2, ' ');
266
267 if (data)
268 {
269 *data++ = 0;
270 datalen = pkt_len - (data - (char *)inbuf);
271 }
272 else
273 {
274 data = (char *)inbuf + 2; // better read garbage than segfault
275 datalen = 0;
276 }
277
278 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
279 if (!strcmp ((char *)inbuf + 2, pkt->name))
280 {
281 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
282 queue_command (pkt, data, datalen);
283 else
284 execute (pkt, data, datalen);
285
286 goto next_packet;
287 }
288
289 // If we get here, we didn't find a valid command.
290 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
291 next_packet:
292 skip_packet (pkt_len);
293
294 // input buffer has space again
295 socket_ev.poll (socket_ev.poll () | EV_READ);
296
297 return true;
298 }
299
300 // callback called when socket is either readable or writable
301 void
302 client::socket_cb (iow &w, int revents)
303 {
304 //TODO remove when we have better socket cleanup logic
305 if (destroyed ())
306 {
307 socket_ev.poll (0);
308 return;
309 }
310
311 if (revents & EV_WRITE)
312 {
313 write_outputbuffer ();
314
315 if (!outputbuffer.len)
316 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
317 }
318
319 if (revents & EV_READ)
320 {
321 //TODO: rate-limit tcp connection in better ways, important
322
323 int amount = sizeof (inbuf) - inbuf_len;
324
325 if (!amount)
326 {
327 // input buffer full
328 socket_ev.poll (socket_ev.poll () & ~EV_READ);
329 return;
330 }
331
332 amount = read (fd, inbuf + inbuf_len, amount);
333
334 if (!amount)
335 {
336 destroy ();
337 return;
338 }
339 else if (amount < 0)
340 {
341 if (errno != EAGAIN && errno != EINTR)
342 {
343 LOG (llevError, "read error: %s\n", strerror (errno));
344 destroy ();
345 return;
346 }
347
348 // should not be here, normally
349 }
350 else
351 {
352 inbuf_len += amount;
353
354 if (handle_packet ())
355 {
356 while (handle_packet ())
357 ;
358
359 flush ();
360 }
361 }
362 }
363 }
364
365 /*******************************************************************************
366 *
367 * Start of write related routines.
368 *
369 ******************************************************************************/
370
371 /**
372 * Adds data to a socket buffer for whatever reason.
373 *
374 * ns is the socket we are adding the data to, buf is the start of the
375 * data, and len is the number of bytes to add.
376 */
377 void
378 client::send (void *buf_, int len)
379 {
380 char *buf = (char *)buf_;
381
382 if (destroyed () || !buf)
383 return;
384
385 if (len + outputbuffer.len > SOCKETBUFSIZE)
386 {
387 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
388 // shutdown the socket, this is safer than destroying it immediately
389 // as lots of code in the callchain might still access the map etc.
390 shutdown (fd, SHUT_RDWR);
391 return;
392 }
393
394 int avail, end;
395
396 /* data + end is where we start putting the new data. The last byte
397 * currently in use is actually data + end -1
398 */
399 end = outputbuffer.start + outputbuffer.len;
400 /* The buffer is already in a wrapped state, so adjust end */
401 if (end >= SOCKETBUFSIZE)
402 end -= SOCKETBUFSIZE;
403
404 avail = SOCKETBUFSIZE - end;
405
406 /* We can all fit it behind the current data without wrapping */
407 if (avail >= len)
408 memcpy (outputbuffer.data + end, buf, len);
409 else
410 {
411 memcpy (outputbuffer.data + end, buf, avail);
412 memcpy (outputbuffer.data, buf + avail, len - avail);
413 }
414
415 outputbuffer.len += len;
416 }
417
418 /**
419 * Takes a string of data, and writes it out to the socket. A very handy
420 * shortcut function.
421 */
422 void
423 client::send_packet (packet &sl)
424 {
425 if (destroyed ())
426 return;
427
428 if (sl.length () > MAXSOCKBUF)
429 {
430 LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
431 /* Almost certainly we've overflowed a buffer, so quit now to make
432 * it easier to debug.
433 */
434 abort ();
435 }
436
437 if (!sl.length ())
438 return;
439
440 assert (sl.hdrlen == 2);
441
442 sl.buf_ [0] = sl.length () >> 8;
443 sl.buf_ [1] = sl.length () ;
444
445 send (sl.buf_, sl.length () + sl.hdrlen);
446 }
447
448 void
449 client::send_packet (const char *buf, int len)
450 {
451 packet sl;
452
453 sl << data (buf, len);
454 send_packet (sl);
455 }
456
457 void
458 client::send_packet (const char *buf)
459 {
460 send_packet (buf, strlen (buf));
461 }
462
463 void
464 client::send_packet_printf (const char *format, ...)
465 {
466 packet sl;
467
468 va_list ap;
469 va_start (ap, format);
470 sl.vprintf (format, ap);
471 va_end (ap);
472
473 send_packet (sl);
474 }
475
476 void
477 client::send_msg (int color, const char *type, const char *msg)
478 {
479 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
480 {
481 LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
482 return;
483 }
484
485 int len = strlen (msg);
486
487 if (!(color & NDI_VERBATIM)
488 && (msg_is_special (msg)
489 || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128)))
490 cfperl_send_msg (this, color, type, msg);
491 else if (can_msg)
492 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
493 else if (color < 0)
494 return; // client cannot handle this
495 else
496 send_packet_printf ("drawinfo %d %s", color & NDI_COLOR_MASK, msg);
497 }
498
499 void
500 client::send_drawinfo (const char *msg, int flags)
501 {
502 send_msg (flags, "log", msg);
503 }
504
505 /***********************************************************************
506 *
507 * packet functions/utilities
508 *
509 **********************************************************************/
510
511 packet::packet (const char *name)
512 {
513 reset ();
514
515 int len = strlen (name);
516 memcpy (cur, name, len); cur += len;
517 *cur++ = ' ';
518 }
519
520 packet &packet::operator <<(const ber32 v)
521 {
522 enum { maxlen = 32 / 7 + 1};
523 uint8 buf[maxlen];
524 uint8 *p = buf + maxlen;
525 uint32 val = v.val;
526
527 *--p = val & 0x7F;
528
529 while (val > 0x7F)
530 {
531 val >>= 7;
532 *--p = (val & 0x7F) | 0x80;
533 }
534
535 return *this << data (p, buf + maxlen - p);
536 }
537
538 packet &packet::operator <<(const data &v)
539 {
540 if (room () < v.len)
541 reset ();
542 else
543 {
544 if (v.len)
545 {
546 memcpy (cur, v.ptr, v.len);
547 cur += v.len;
548 }
549 }
550
551 return *this;
552 }
553
554 packet &packet::operator <<(const data8 &v)
555 {
556 unsigned int len = min (v.len, 0x00FF);
557 return *this << uint8 (len) << data (v.ptr, len);
558 }
559
560 packet &packet::operator <<(const data16 &v)
561 {
562 unsigned int len = min (v.len, 0xFFFF);
563 return *this << uint16 (len) << data (v.ptr, len);
564 }
565
566 packet &packet::operator <<(const char *v)
567 {
568 return *this << data (v, strlen (v ? v : 0));
569 }
570
571 void
572 packet::vprintf (const char *format, va_list ap)
573 {
574 int size = room ();
575
576 int len = vsnprintf ((char *)cur, size, format, ap);
577
578 if (len >= size)
579 return reset ();
580
581 cur += len;
582 }
583