ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.75
Committed: Fri Mar 26 01:04:45 2010 UTC (14 years, 2 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.74: +1 -1 lines
Log Message:
update copyright for up to 2010

File Contents

# User Rev Content
1 elmex 1.1 /*
2 root 1.62 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 pippijn 1.32 *
4 root 1.75 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 root 1.42 *
6 root 1.71 * 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 root 1.42 *
11 root 1.49 * 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 root 1.42 *
16 root 1.71 * 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 pippijn 1.32 *
20 root 1.62 * The authors can be reached via e-mail to <support@deliantra.net>
21 pippijn 1.32 */
22 root 1.42
23 elmex 1.1 using namespace std;
24    
25     #include <global.h>
26     #include <sproto.h>
27 root 1.11 #include <cstdarg>
28 elmex 1.1
29 root 1.45 #if HAVE_TCP_INFO
30 elmex 1.1 # include <sys/types.h>
31     # include <sys/socket.h>
32     # include <netinet/in.h>
33     # include <netinet/tcp.h>
34     #endif
35    
36 root 1.43 // force a packet when idle for more than this many seconds,
37     // forcing an ack regularly.
38     #define IDLE_PING 2.
39 elmex 1.1
40 root 1.5 void
41 root 1.22 client::flush ()
42 elmex 1.1 {
43 root 1.29 if (destroyed ())
44     return;
45    
46 root 1.20 /**
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 root 1.43 // write a nop to the socket at least every IDLE_NOP seconds.
54     if (!outputbuffer.len)
55     {
56 root 1.47 if (last_send + IDLE_PING <= NOW && pl && pl->active)
57 root 1.43 {
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 root 1.63 if (socket_ev.poll () & EV_WRITE)
68 root 1.20 return;
69    
70 root 1.43 last_send = NOW;
71 root 1.20 write_outputbuffer ();
72     }
73 elmex 1.1
74 root 1.20 void
75 root 1.22 client::write_outputbuffer ()
76 root 1.20 {
77     while (outputbuffer.len)
78     {
79     int res = write (fd, outputbuffer.data + outputbuffer.start,
80     min (outputbuffer.len, SOCKETBUFSIZE - outputbuffer.start));
81 root 1.5
82 root 1.20 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 root 1.23 destroy ();
95 root 1.20 return;
96     }
97     else if (errno == EINTR)
98     {
99     // just retry
100     }
101     else if (errno == EAGAIN)
102     {
103     // delay till ready
104 root 1.63 socket_ev.poll (socket_ev.poll () | EV_WRITE);
105 root 1.20 socket_ev.start ();
106     return;
107     }
108     else
109     {
110     LOG (llevError, "socket write failed: %s\n", strerror (errno));
111 root 1.23 destroy ();
112 root 1.20 return;
113     }
114     }
115    
116 root 1.63 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
117 elmex 1.1 }
118    
119 root 1.23 /******************************************************************************
120 elmex 1.1 *
121 root 1.23 * Start of read routines.
122 elmex 1.1 *
123 root 1.23 ******************************************************************************/
124 elmex 1.1
125 root 1.23 int
126     client::next_packet ()
127 elmex 1.1 {
128 root 1.23 if (inbuf_len >= 2)
129 root 1.11 {
130 root 1.23 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 root 1.15 {
137 root 1.53 send_packet_printf ("drawinfo %d input buffer overflow - closing connection.", NDI_RED | NDI_REPLY);
138 root 1.23 destroy ();
139     return -1;
140 root 1.15 }
141 root 1.11 }
142 root 1.9
143 root 1.23 return 0;
144 root 1.11 }
145 root 1.9
146 root 1.23 void
147     client::skip_packet (int len)
148 root 1.11 {
149 root 1.23 inbuf_len -= len;
150     memmove (inbuf, inbuf + len, inbuf_len);
151 elmex 1.1 }
152    
153 root 1.23 /*****************************************************************************
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 root 1.33 {"ncom", PC(NewPlayerCmd) PF_PLAYING | PF_COMMAND6 },
167     {"command", PC(PlayerCmd) PF_PLAYING | PF_COMMAND0 },
168 root 1.23
169     {"examine", PC(ExamineCmd) PF_PLAYING },
170 root 1.39 {"ex", PC(ExCmd) PF_PLAYING },
171 root 1.23 {"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 root 1.39 {"ext", PC(ExtCmd) 0 }, // CF+
177     {"mapredraw", PC(MapRedrawCmd) 0 },
178     {"mapinfo", PC(MapInfoCmd) 0 }, // CF+
179 root 1.23
180 root 1.28 {"reply", SC(ReplyCmd) 0 },
181 root 1.39 {"exti", SC(ExtiCmd) 0 }, // CF+
182 root 1.26 {"addme", SC(AddMeCmd) 0 },
183 root 1.36 {"askface", SC(AskFaceCmd) 0 },
184 root 1.26 {"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 root 1.23 };
190    
191     bool
192     client::may_execute (const packet_type *pkt) const
193 elmex 1.1 {
194 root 1.23 return (!(pkt->flags & PF_PLAYER) || pl)
195 root 1.29 && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
196 root 1.11 }
197 root 1.9
198 root 1.33 // 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 root 1.70 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 root 1.61
224     if (len == 7 && !strcmp (data, "suicide")) return true;
225 root 1.33
226     return false;
227     }
228    
229 root 1.23 void
230     client::execute (const packet_type *pkt, char *data, int datalen)
231 root 1.11 {
232 root 1.33 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
233 root 1.23 {
234     //TODO: only one format
235     if (pkt->flags & PF_PLAYER)
236 root 1.74 {
237     ((void (*)(char *, int, player *))pkt->cb)((char *)data, datalen, pl);
238     pl->need_updated_stats ();
239     }
240 root 1.23 else
241     ((void (*)(char *, int, client *))pkt->cb)((char *)data, datalen, this);
242     }
243     else
244 root 1.53 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
245 elmex 1.1 }
246    
247 root 1.23 bool
248     client::handle_packet ()
249 root 1.10 {
250 root 1.23 int pkt_len = next_packet ();
251    
252     if (!pkt_len)
253     return false;
254     else if (pkt_len < 0)
255     {
256     LOG (llevError, "read error on player %s\n",
257     pl && pl->ob ? &pl->ob->name : "[anonymous]");
258     destroy ();
259     return false;
260     }
261    
262 root 1.72 uint8_t save_byte = inbuf [pkt_len]; // rather ugly
263     inbuf [pkt_len] = 0; /* temporarily terminate buffer - useful for string data */
264 root 1.23
265     /* First, break out beginning word. There are at least
266     * a few commands that do not have any paremeters. If
267     * we get such a command, don't worry about trying
268     * to break it up.
269     */
270     int datalen;
271     char *data = strchr ((char *)inbuf + 2, ' ');
272    
273     if (data)
274     {
275     *data++ = 0;
276     datalen = pkt_len - (data - (char *)inbuf);
277     }
278     else
279     {
280     data = (char *)inbuf + 2; // better read garbage than segfault
281     datalen = 0;
282     }
283 root 1.15
284 root 1.23 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
285     if (!strcmp ((char *)inbuf + 2, pkt->name))
286     {
287 root 1.33 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
288 root 1.26 queue_command (pkt, data, datalen);
289     else
290 root 1.23 execute (pkt, data, datalen);
291    
292     goto next_packet;
293     }
294    
295 root 1.26 // If we get here, we didn't find a valid command.
296 root 1.53 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
297 root 1.72
298 root 1.23 next_packet:
299 root 1.72 inbuf [pkt_len] = save_byte; // rather ugly
300 root 1.23 skip_packet (pkt_len);
301 root 1.11
302 root 1.23 // input buffer has space again
303 root 1.63 socket_ev.poll (socket_ev.poll () | EV_READ);
304 root 1.10
305 root 1.23 return true;
306 root 1.10 }
307    
308 root 1.23 // callback called when socket is either readable or writable
309     void
310 root 1.63 client::socket_cb (iow &w, int revents)
311 root 1.23 {
312     //TODO remove when we have better socket cleanup logic
313 root 1.29 if (destroyed ())
314 root 1.23 {
315     socket_ev.poll (0);
316     return;
317     }
318 elmex 1.1
319 root 1.63 if (revents & EV_WRITE)
320 root 1.5 {
321 root 1.23 write_outputbuffer ();
322    
323     if (!outputbuffer.len)
324 root 1.63 socket_ev.poll (socket_ev.poll () & ~EV_WRITE);
325 root 1.23 }
326 root 1.12
327 root 1.63 if (revents & EV_READ)
328 root 1.23 {
329     //TODO: rate-limit tcp connection in better ways, important
330 pippijn 1.8
331 root 1.12 int amount = sizeof (inbuf) - inbuf_len;
332    
333 root 1.23 if (!amount)
334 root 1.5 {
335 root 1.23 // input buffer full
336 root 1.63 socket_ev.poll (socket_ev.poll () & ~EV_READ);
337 root 1.23 return;
338 root 1.3 }
339 elmex 1.1
340 root 1.12 amount = read (fd, inbuf + inbuf_len, amount);
341    
342     if (!amount)
343 root 1.5 {
344 root 1.23 destroy ();
345     return;
346 root 1.5 }
347 root 1.12 else if (amount < 0)
348 root 1.5 {
349 root 1.12 if (errno != EAGAIN && errno != EINTR)
350 root 1.5 {
351 root 1.20 LOG (llevError, "read error: %s\n", strerror (errno));
352 root 1.23 destroy ();
353     return;
354 root 1.3 }
355 root 1.12
356 root 1.23 // should not be here, normally
357 root 1.3 }
358 root 1.23 else
359     {
360     inbuf_len += amount;
361 root 1.12
362 root 1.60 if (handle_packet ())
363     {
364     while (handle_packet ())
365     ;
366    
367     flush ();
368     }
369 root 1.23 }
370 root 1.5 }
371 root 1.12 }
372    
373 elmex 1.1 /*******************************************************************************
374     *
375     * Start of write related routines.
376     *
377     ******************************************************************************/
378    
379     /**
380     * Adds data to a socket buffer for whatever reason.
381     *
382     * ns is the socket we are adding the data to, buf is the start of the
383     * data, and len is the number of bytes to add.
384     */
385 root 1.20 void
386 root 1.22 client::send (void *buf_, int len)
387 root 1.20 {
388     char *buf = (char *)buf_;
389 elmex 1.1
390 root 1.29 if (destroyed () || !buf)
391 root 1.23 return;
392 elmex 1.1
393 root 1.31 if (len + outputbuffer.len > SOCKETBUFSIZE)
394 root 1.5 {
395 root 1.23 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
396 root 1.36 // shutdown the socket, this is safer than destroying it immediately
397     // as lots of code in the callchain might still access the map etc.
398     shutdown (fd, SHUT_RDWR);
399 root 1.5 return;
400     }
401    
402 root 1.20 int avail, end;
403    
404 root 1.5 /* data + end is where we start putting the new data. The last byte
405     * currently in use is actually data + end -1
406     */
407 root 1.20 end = outputbuffer.start + outputbuffer.len;
408 root 1.5 /* The buffer is already in a wrapped state, so adjust end */
409     if (end >= SOCKETBUFSIZE)
410     end -= SOCKETBUFSIZE;
411 root 1.7
412 root 1.5 avail = SOCKETBUFSIZE - end;
413 elmex 1.1
414 root 1.5 /* We can all fit it behind the current data without wrapping */
415     if (avail >= len)
416 root 1.20 memcpy (outputbuffer.data + end, buf, len);
417 root 1.5 else
418     {
419 root 1.20 memcpy (outputbuffer.data + end, buf, avail);
420     memcpy (outputbuffer.data, buf + avail, len - avail);
421 elmex 1.1 }
422 root 1.7
423 root 1.20 outputbuffer.len += len;
424 elmex 1.1 }
425    
426     /**
427     * Takes a string of data, and writes it out to the socket. A very handy
428     * shortcut function.
429     */
430 root 1.13 void
431 root 1.22 client::send_packet (packet &sl)
432 root 1.13 {
433 root 1.29 if (destroyed ())
434 root 1.19 return;
435    
436 root 1.55 if (sl.length () > MAXSOCKBUF)
437 root 1.19 {
438     LOG (llevError, "Trying to send a buffer beyond properly size, len =%d\n", sl.length ());
439     /* Almost certainly we've overflowed a buffer, so quit now to make
440     * it easier to debug.
441     */
442     abort ();
443     }
444    
445     if (!sl.length ())
446     return;
447    
448     assert (sl.hdrlen == 2);
449    
450     sl.buf_ [0] = sl.length () >> 8;
451     sl.buf_ [1] = sl.length () ;
452    
453     send (sl.buf_, sl.length () + sl.hdrlen);
454 root 1.13 }
455    
456 root 1.5 void
457 root 1.22 client::send_packet (const char *buf, int len)
458 elmex 1.1 {
459 root 1.14 packet sl;
460 elmex 1.1
461 root 1.13 sl << data (buf, len);
462     send_packet (sl);
463 elmex 1.1 }
464    
465 root 1.13 void
466 root 1.22 client::send_packet (const char *buf)
467 root 1.13 {
468     send_packet (buf, strlen (buf));
469     }
470 elmex 1.1
471 root 1.23 void
472     client::send_packet_printf (const char *format, ...)
473     {
474     packet sl;
475    
476     va_list ap;
477     va_start (ap, format);
478     sl.vprintf (format, ap);
479     va_end (ap);
480    
481     send_packet (sl);
482     }
483    
484 root 1.40 void
485     client::send_msg (int color, const char *type, const char *msg)
486     {
487 root 1.58 if (!msg || !type) // it can happen (for example, missing attack messages cause this)
488     {
489     LOG (logBacktrace | llevError, "send_msg(%d,%p,%p) called with NULL msg or type.\n", color, type, msg);
490     return;
491     }
492    
493 root 1.59 int len = strlen (msg);
494    
495 root 1.66 if (!(color & NDI_VERBATIM)
496     && (msg_is_special (msg)
497     || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128)))
498 root 1.48 cfperl_send_msg (this, color, type, msg);
499 root 1.69 else
500 root 1.53 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
501 root 1.40 }
502    
503 root 1.48 void
504     client::send_drawinfo (const char *msg, int flags)
505     {
506     send_msg (flags, "log", msg);
507     }
508    
509 root 1.23 /***********************************************************************
510     *
511     * packet functions/utilities
512     *
513     **********************************************************************/
514    
515 root 1.27 packet::packet (const char *name)
516     {
517     reset ();
518    
519     int len = strlen (name);
520     memcpy (cur, name, len); cur += len;
521     *cur++ = ' ';
522     }
523    
524 root 1.37 packet &packet::operator <<(const ber32 v)
525     {
526     enum { maxlen = 32 / 7 + 1};
527     uint8 buf[maxlen];
528     uint8 *p = buf + maxlen;
529     uint32 val = v.val;
530    
531 root 1.38 *--p = val & 0x7F;
532    
533 root 1.37 while (val > 0x7F)
534     {
535 root 1.38 val >>= 7;
536 root 1.37 *--p = (val & 0x7F) | 0x80;
537     }
538    
539     return *this << data (p, buf + maxlen - p);
540     }
541    
542 root 1.23 packet &packet::operator <<(const data &v)
543     {
544     if (room () < v.len)
545     reset ();
546     else
547     {
548     if (v.len)
549     {
550     memcpy (cur, v.ptr, v.len);
551     cur += v.len;
552     }
553     }
554    
555     return *this;
556     }
557    
558     packet &packet::operator <<(const data8 &v)
559     {
560     unsigned int len = min (v.len, 0x00FF);
561     return *this << uint8 (len) << data (v.ptr, len);
562     }
563    
564     packet &packet::operator <<(const data16 &v)
565     {
566     unsigned int len = min (v.len, 0xFFFF);
567     return *this << uint16 (len) << data (v.ptr, len);
568     }
569    
570     packet &packet::operator <<(const char *v)
571     {
572     return *this << data (v, strlen (v ? v : 0));
573     }
574    
575     void
576     packet::vprintf (const char *format, va_list ap)
577     {
578     int size = room ();
579    
580     int len = vsnprintf ((char *)cur, size, format, ap);
581    
582     if (len >= size)
583     return reset ();
584    
585     cur += len;
586     }
587