ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/socket/lowlevel.C
Revision: 1.61
Committed: Fri Oct 5 23:03:49 2007 UTC (16 years, 7 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-2_3
Changes since 1.60: +5 -4 lines
Log Message:
add shout and suicide to the list of immediate commands

File Contents

# User Rev Content
1 elmex 1.1 /*
2 root 1.49 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3 pippijn 1.32 *
4 root 1.42 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5     * Copyright (©) 1992,2007 Frank Tore Johansen
6     *
7 root 1.49 * Crossfire TRT 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 root 1.42 *
12 root 1.49 * 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 root 1.42 *
17 root 1.49 * 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 pippijn 1.32 *
20 root 1.42 * The authors can be reached via e-mail to <crossfire@schmorp.de>
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     if (socket_ev.poll () & PE_W)
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     socket_ev.poll (socket_ev.poll () | PE_W);
105     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     socket_ev.poll (socket_ev.poll () & ~PE_W);
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     {"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 root 1.23 };
193    
194     bool
195     client::may_execute (const packet_type *pkt) const
196 elmex 1.1 {
197 root 1.23 return (!(pkt->flags & PF_PLAYER) || pl)
198 root 1.29 && (!(pkt->flags & PF_PLAYING) || state == ST_PLAYING);
199 root 1.11 }
200 root 1.9
201 root 1.33 // 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 root 1.61 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 root 1.33
227     return false;
228     }
229    
230 root 1.23 void
231     client::execute (const packet_type *pkt, char *data, int datalen)
232 root 1.11 {
233 root 1.33 if (may_execute (pkt) || always_immediate (this, pkt, data, datalen))
234 root 1.23 {
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 root 1.53 send_packet_printf ("drawinfo %d ERROR: you cannot execute '%s' now.", NDI_RED | NDI_REPLY, pkt->name);
243 elmex 1.1 }
244    
245 root 1.23 bool
246     client::handle_packet ()
247 root 1.10 {
248 root 1.23 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 root 1.15
281 root 1.23 for (packet_type *pkt = packets; pkt < packets + (sizeof (packets) / sizeof (packets[0])); ++pkt)
282     if (!strcmp ((char *)inbuf + 2, pkt->name))
283     {
284 root 1.33 if (pkt->flags & PF_PLAYER && !always_immediate (this, pkt, data, datalen))
285 root 1.26 queue_command (pkt, data, datalen);
286     else
287 root 1.23 execute (pkt, data, datalen);
288    
289     goto next_packet;
290     }
291    
292 root 1.26 // If we get here, we didn't find a valid command.
293 root 1.53 send_packet_printf ("drawinfo %d ERROR: command '%s' not supported.", NDI_RED | NDI_REPLY, (char *)inbuf + 2);
294 root 1.23 next_packet:
295     skip_packet (pkt_len);
296 root 1.11
297 root 1.23 // input buffer has space again
298     socket_ev.poll (socket_ev.poll () | PE_R);
299 root 1.10
300 root 1.23 return true;
301 root 1.10 }
302    
303 root 1.23 // callback called when socket is either readable or writable
304     void
305     client::socket_cb (iow &w, int got)
306     {
307     //TODO remove when we have better socket cleanup logic
308 root 1.29 if (destroyed ())
309 root 1.23 {
310     socket_ev.poll (0);
311     return;
312     }
313 elmex 1.1
314 root 1.23 if (got & PE_W)
315 root 1.5 {
316 root 1.23 write_outputbuffer ();
317    
318     if (!outputbuffer.len)
319     socket_ev.poll (socket_ev.poll () & ~PE_W);
320     }
321 root 1.12
322 root 1.23 if (got & PE_R)
323     {
324     //TODO: rate-limit tcp connection in better ways, important
325 pippijn 1.8
326 root 1.12 int amount = sizeof (inbuf) - inbuf_len;
327    
328 root 1.23 if (!amount)
329 root 1.5 {
330 root 1.23 // input buffer full
331     socket_ev.poll (socket_ev.poll () & ~PE_R);
332     return;
333 root 1.3 }
334 elmex 1.1
335 root 1.12 amount = read (fd, inbuf + inbuf_len, amount);
336    
337     if (!amount)
338 root 1.5 {
339 root 1.23 destroy ();
340     return;
341 root 1.5 }
342 root 1.12 else if (amount < 0)
343 root 1.5 {
344 root 1.12 if (errno != EAGAIN && errno != EINTR)
345 root 1.5 {
346 root 1.20 LOG (llevError, "read error: %s\n", strerror (errno));
347 root 1.23 destroy ();
348     return;
349 root 1.3 }
350 root 1.12
351 root 1.23 // should not be here, normally
352 root 1.3 }
353 root 1.23 else
354     {
355     inbuf_len += amount;
356 root 1.12
357 root 1.60 if (handle_packet ())
358     {
359     while (handle_packet ())
360     ;
361    
362     flush ();
363     }
364 root 1.23 }
365 root 1.5 }
366 root 1.12 }
367    
368 elmex 1.1 /*******************************************************************************
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 root 1.20 void
381 root 1.22 client::send (void *buf_, int len)
382 root 1.20 {
383     char *buf = (char *)buf_;
384 elmex 1.1
385 root 1.29 if (destroyed () || !buf)
386 root 1.23 return;
387 elmex 1.1
388 root 1.31 if (len + outputbuffer.len > SOCKETBUFSIZE)
389 root 1.5 {
390 root 1.23 LOG (llevDebug, "socket on fd %d has overrun internal buffer - marking as dead\n", fd);
391 root 1.36 // 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 root 1.5 return;
395     }
396    
397 root 1.20 int avail, end;
398    
399 root 1.5 /* data + end is where we start putting the new data. The last byte
400     * currently in use is actually data + end -1
401     */
402 root 1.20 end = outputbuffer.start + outputbuffer.len;
403 root 1.5 /* The buffer is already in a wrapped state, so adjust end */
404     if (end >= SOCKETBUFSIZE)
405     end -= SOCKETBUFSIZE;
406 root 1.7
407 root 1.5 avail = SOCKETBUFSIZE - end;
408 elmex 1.1
409 root 1.5 /* We can all fit it behind the current data without wrapping */
410     if (avail >= len)
411 root 1.20 memcpy (outputbuffer.data + end, buf, len);
412 root 1.5 else
413     {
414 root 1.20 memcpy (outputbuffer.data + end, buf, avail);
415     memcpy (outputbuffer.data, buf + avail, len - avail);
416 elmex 1.1 }
417 root 1.7
418 root 1.20 outputbuffer.len += len;
419 elmex 1.1 }
420    
421     /**
422     * Takes a string of data, and writes it out to the socket. A very handy
423     * shortcut function.
424     */
425 root 1.13 void
426 root 1.22 client::send_packet (packet &sl)
427 root 1.13 {
428 root 1.29 if (destroyed ())
429 root 1.19 return;
430    
431 root 1.55 if (sl.length () > MAXSOCKBUF)
432 root 1.19 {
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 root 1.13 }
450    
451 root 1.5 void
452 root 1.22 client::send_packet (const char *buf, int len)
453 elmex 1.1 {
454 root 1.14 packet sl;
455 elmex 1.1
456 root 1.13 sl << data (buf, len);
457     send_packet (sl);
458 elmex 1.1 }
459    
460 root 1.13 void
461 root 1.22 client::send_packet (const char *buf)
462 root 1.13 {
463     send_packet (buf, strlen (buf));
464     }
465 elmex 1.1
466 root 1.23 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 root 1.48 // 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 root 1.35 }
485    
486 root 1.40 void
487     client::send_msg (int color, const char *type, const char *msg)
488     {
489 root 1.58 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 root 1.59 int len = strlen (msg);
496    
497     if (msg_is_special (msg) || (type [0] == 'c' && type [1] == '/') || len > (MAXSOCKBUF - 128))
498 root 1.48 cfperl_send_msg (this, color, type, msg);
499     else if (can_msg)
500 root 1.53 send_packet_printf ("msg %d %s %s", color & NDI_CLIENT_MASK, type, msg);
501 root 1.40 else if (color < 0)
502     return; // client cannot handle this
503     else
504 root 1.53 send_packet_printf ("drawinfo %d %s", color & NDI_COLOR_MASK, msg);
505 root 1.40 }
506    
507 root 1.48 void
508     client::send_drawinfo (const char *msg, int flags)
509     {
510     send_msg (flags, "log", msg);
511     }
512    
513 root 1.23 /***********************************************************************
514     *
515     * packet functions/utilities
516     *
517     **********************************************************************/
518    
519 root 1.27 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 root 1.37 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 root 1.38 *--p = val & 0x7F;
536    
537 root 1.37 while (val > 0x7F)
538     {
539 root 1.38 val >>= 7;
540 root 1.37 *--p = (val & 0x7F) | 0x80;
541     }
542    
543     return *this << data (p, buf + maxlen - p);
544     }
545    
546 root 1.23 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