--- deliantra/server/include/client.h 2007/06/24 04:09:29 1.55
+++ deliantra/server/include/client.h 2010/04/08 19:31:22 1.96
@@ -1,40 +1,73 @@
/*
- * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
+ * This file is part of Deliantra, the Roguelike Realtime MMORPG.
*
- * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
- * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
- * Copyright (©) 1992,2007 Frank Tore Johansen
+ * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
*
- * Crossfire TRT is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the Free
- * Software Foundation; either version 2 of the License, or (at your option)
- * any later version.
+ * Deliantra is free software: you can redistribute it and/or modify it under
+ * the terms of the Affero GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
*
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
- * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * for more details.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*
- * You should have received a copy of the GNU General Public License along
- * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
- * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * You should have received a copy of the Affero GNU General Public License
+ * and the GNU General Public License along with this program. If not, see
+ * .
*
- * The authors can be reached via e-mail to
+ * The authors can be reached via e-mail to
*/
#ifndef CLIENT_H
#define CLIENT_H
-#include
-#include
-#include
+#if HAVE_TCP_INFO
+# include
+#else
+ struct tcp_info {
+ // dummy
+ int tcpi_state;
+ int tcpi_ca_state;
+ int tcpi_retransmits;
+ int tcpi_probes;
+ int tcpi_backoff;
+ int tcpi_options;
+ int tcpi_snd_wscale;
+ int tcpi_rcv_wscale;
+ int tcpi_rto;
+ int tcpi_ato;
+ int tcpi_snd_mss;
+ int tcpi_rcv_mss;
+ int tcpi_unacked;
+ int tcpi_sacked;
+ int tcpi_lost;
+ int tcpi_retrans;
+ int tcpi_fackets;
+ int tcpi_last_data_sent;
+ int tcpi_last_ack_sent;
+ int tcpi_last_data_recv;
+ int tcpi_last_ack_recv;
+ int tcpi_pmtu;
+ int tcpi_rcv_ssthresh;
+ int tcpi_rtt;
+ int tcpi_rttvar;
+ int tcpi_snd_ssthresh;
+ int tcpi_snd_cwnd;
+ int tcpi_advmss;
+ int tcpi_reordering;
+ };
+#endif
+
+//+GPL
// (possibly) max. number of objects "per page" in the ground container
#define FLOORBOX_PAGESIZE 50
struct MapCell
{
- tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
+ tag_t player; // this is, unfortunately, very wasteful of memory space, but pretty bandwidth-efficient
int count; /* This is really darkness in the map1 command */
faceidx faces[MAP_LAYERS];
unsigned char stat_hp; // health of something in this space, or 0
@@ -88,6 +121,15 @@
PF_COMMAND6 = 0x08, // command starts at offset 6
};
+// face type.s bit 0 means "has meta info prepended"
+enum {
+ FT_FACE = 0 * 2 + 0, // faces (images)
+ FT_MUSIC = 1 * 2 + 1, // background music
+ FT_SOUND = 2 * 2 + 1, // effects
+ FT_RSRC = 3 * 2 + 0, // generic data files
+ FT_NUM,
+};
+
struct packet_type
{
const char *name;
@@ -101,13 +143,10 @@
const packet_type *handler;
char *data;
int datalen;
-
- ~command ()
- {
- sfree (data, datalen + 1);
- }
};
+//-GPL
+
/* how many times we are allowed to give the wrong password before being kicked. */
#define MAX_PASSWORD_FAILURES 5
@@ -120,16 +159,6 @@
object_vector_index ACC (RO, active);
player_ptr ACC (RO, pl);
- /* The following is the setup for a ring buffer for storing output
- * data that the OS can't handle right away.
- */
- struct
- {
- char data[SOCKETBUFSIZE];
- int start;
- int len;
- } outputbuffer;
-
char *ACC (RW, host); /* Which host it is connected from (ip address) */
uint8 ACC (RW, state); /* Input state of the player (name, password, etc */
@@ -146,71 +175,63 @@
sint16 ACC (RW, last_resist[NROFATTACKS]);/* last resist values sent to client */
sint64 ACC (RW, last_skill_exp[NUM_SKILLS]);/* shadow register. if != exp. obj update client */
- bool ACC (RW, force_face0); // client workaround for buggy checksum calculation in gcfclient
- bool ACC (RW, force_bad_checksum); // client workaround for buggy checksum calculation in gcfclient
- bool ACC (RW, force_image_newmap); // client workaround for client not redrawing map on image upload
- bool ACC (RW, enable_bg_scrub); // client workaround, gcfclient becomes unusable if you send it images
-
bool ACC (RW, afk); /* player is afk */
- bool ACC (RW, facecache); /* If true, client is caching images */
bool ACC (RW, sent_scroll);
bool ACC (RW, sound); /* does the client want sound */
bool ACC (RW, newmapcmd); /* Send newmap command when entering new map SMACFIGGEN */
bool ACC (RW, plugincmd); // extend the protocol through a plug-in */
bool ACC (RW, mapinfocmd); // return map info and send map change info
- bool ACC (RW, extcmd); // call into extensions/plugins
- bool ACC (RW, extmap); // extend map comamnd with extra data
- bool ACC (RW, buggy_mapscroll); // client crashes on large mapscrolls
- bool ACC (RW, darkness); /* True if client wants darkness information */
- bool ACC (RW, image2); /* Client wants image2/face2 commands */
- bool ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
+ uint8_t ACC (RW, extcmd); // call into extensions/plugins
bool ACC (RW, update_look); /* If true, we need to send the look window */
+ bool ACC (RW, update_spells); // If true, we need to esrv_update_spells
bool ACC (RW, has_readable_type); /* If true client accept additional text information */
/* used to arrange text in books, scrolls, or scripted dialogs */
bool ACC (RW, monitor_spells); /* Client wishes to be informed when their spell list changes */
- bool ACC (RW, ext_mapinfos); /* If true client accepts additional info on maps */
- /* Below are flags for extedend infos to pass to client
- * with S->C mapextended command */
- bool ACC (RW, EMI_smooth); /* Send smooth in extendmapinfos */
- bool ACC (RW, smoothing); // trt-style smoothing
- bool ACC (RW, can_msg); // trt-style text messages
+ bool ACC (RW, smoothing); // deliantra-style smoothing
bool ACC (RW, force_newmap); // force a newmap before next map update
uint32 ACC (RW, supported_readables); /* each bit is a readable supported by client */
- uint32 ACC (RW, cs_version), ACC (RW, sc_version); /* versions of the client */
uint16 ACC (RW, look_position); /* start of drawing of look window */
uint16 ACC (RW, mss); // likely tcp maximum segment size
uint8 ACC (RW, mapmode); /* Type of map commands the client wants. */
uint8 ACC (RW, mapx), ACC (RW, mapy); /* How large a map the client wants */
uint8 ACC (RW, itemcmd); /* What version of the 'item' protocol command to use */
- maptile *ACC (RW, current_map); // CF+ last/current player map
- region *ACC (RW, current_region); // CF+ last/current player region
+ maptile_ptr ACC (RW, current_map); // CF+ last/current player map
+ region_ptr ACC (RW, current_region); // CF+ last/current player region
int ACC (RW, current_x), ACC (RW, current_y); // CF+ last/current map position
- shstr ACC (RW, version); // CF+ client name/version
uint8 ACC (RW, faceset); // CF+ selected faceset
tstamp ACC (RW, last_send); // last data send on socket.
- int ACC (RW, rtt), ACC (RW, rttvar); /* round-trip time and -variance, if known */
-
+ float ACC (RW, socket_timeout); /* after how many seconds of no ack do we declare dead */
int ACC (RW, rate_avail); // current rate balance
int ACC (RW, max_rate); // max. # of bytes to send per tick
faceidx ACC (RW, scrub_idx); // which face to send next
int ACC (RW, bg_scrub); // how many ticks till the next background face send
- faceidx partial_face;
- uint32 partial_face_ofs; // if != 0, need to send remaining bytes of partial_face
- std::vector > askface; // which faces have been requested by the client
+ struct tcp_info tcpi;
+ tstamp next_rate_adjust;
+
+ unordered_vector mapinfo_queue;
+ void mapinfo_queue_clear ();
+ void mapinfo_queue_run ();
+ bool mapinfo_try (char *buf);
+
+ struct ixsend {
+ int16_t pri; // unused
+ faceidx idx;
+ uint32_t ofs; // if != 0, need to send remaining bytes of partial_face
+ };
+ std::vector > ixface; // which faces to send to the client using ix
- std::vector > fxface; // which faces to send using fx
+ std::vector > fxface; // which faces to send using fx
MTH void flush_fx (); // send fx if required
void do_destroy ();
void gather_callbacks (AV *&callbacks, event_type event) const;
- iow socket_ev; void socket_cb (iow &w, int got);
- iw cmd_ev; void cmd_cb (iw &w);
+ iow socket_ev; void socket_cb (iow &w, int revents);
std::deque< command, slice_allocator > cmd_queue;
@@ -218,6 +239,7 @@
struct Map lastmap;
std::bitset anims_sent;
std::bitset faces_sent;
+ std::bitset fx_want;
// if we get an incomplete packet, this is used to hold the data.
// we add 2 byte for the header, one for the trailing 0 byte
@@ -232,7 +254,18 @@
char msg[MSG_BUF_SIZE];
} msgbuf[MSG_BUF_COUNT];
- MTH bool msg_suppressed (const char *msg);
+ MTH bool msg_suppressed (const_utf8_string msg);
+
+ /* The following is the setup for a ring buffer for storing output
+ * data that the OS can't handle right away.
+ * TODO: this member is enourmously large - optimise?
+ */
+ struct
+ {
+ char data[SOCKETBUFSIZE];
+ int start;
+ int len;
+ } outputbuffer;
bool may_execute (const packet_type *pkt) const;
void execute (const packet_type *pkt, char *data, int datalen);
@@ -253,18 +286,19 @@
MTH int outputbuffer_len () const { return outputbuffer.len; }
void send (void *buf_, int len);
- void send_packet (const char *buf);
- void send_packet (const char *buf, int len);
- void send_packet_printf (const char *format, ...);
+ void send_packet (const_octet_string buf);
+ void send_packet (const_octet_string buf, int len);
+ void send_packet_printf (const_utf8_string format, ...) attribute ((format (printf, 2, 3)));
void send_packet (packet &sl);
- void send_drawinfo (const char *msg, int flags = NDI_BLACK);
- MTH void send_face (faceidx facenum);
- MTH void send_image (faceidx facenum);
+ void send_drawinfo (const_utf8_string msg, int flags = NDI_BLACK);
+
+ MTH void send_face (faceidx facenum, int pri = 0);
MTH void send_faces (object *ob);
MTH void send_animation (short anim_num);
- void send_msg (int color, const char *type, const char *msg);
+ void send_msg (int color, const_utf8_string type, const_utf8_string msg);
+ MTH void play_sound (faceidx sound, int dx = 0, int dy = 0);
// called when something under the player changes
MTH void floorbox_update () { update_look = 1; }
// called when the player has been moved
@@ -273,50 +307,57 @@
MTH void tick (); // called every server tick to do housekeeping etc.
MTH static client *create (int fd, const char *peername);
+ MTH static void clock ();
+ MTH static void flush_sockets ();
protected:
client (int fd, const char *from_ip);
~client ();
};
+#if FOR_PERL
+ ACC (RW, tcpi.tcpi_state);
+ ACC (RW, tcpi.tcpi_ca_state);
+ ACC (RW, tcpi.tcpi_retransmits);
+ ACC (RW, tcpi.tcpi_probes);
+ ACC (RW, tcpi.tcpi_backoff);
+ ACC (RW, tcpi.tcpi_options);
+ ACC (RO, tcpi.tcpi_snd_wscale);
+ ACC (RO, tcpi.tcpi_rcv_wscale);
+ ACC (RW, tcpi.tcpi_rto);
+ ACC (RW, tcpi.tcpi_ato);
+ ACC (RW, tcpi.tcpi_snd_mss);
+ ACC (RW, tcpi.tcpi_rcv_mss);
+ ACC (RW, tcpi.tcpi_unacked);
+ ACC (RW, tcpi.tcpi_sacked);
+ ACC (RW, tcpi.tcpi_lost);
+ ACC (RW, tcpi.tcpi_retrans);
+ ACC (RW, tcpi.tcpi_fackets);
+ ACC (RW, tcpi.tcpi_last_data_sent);
+ ACC (RW, tcpi.tcpi_last_ack_sent);
+ ACC (RW, tcpi.tcpi_last_data_recv);
+ ACC (RW, tcpi.tcpi_last_ack_recv);
+ ACC (RW, tcpi.tcpi_pmtu);
+ ACC (RW, tcpi.tcpi_rcv_ssthresh);
+ ACC (RW, tcpi.tcpi_rtt);
+ ACC (RW, tcpi.tcpi_rttvar);
+ ACC (RW, tcpi.tcpi_snd_ssthresh);
+ ACC (RW, tcpi.tcpi_snd_cwnd);
+ ACC (RW, tcpi.tcpi_advmss);
+ ACC (RW, tcpi.tcpi_reordering);
+#endif
+
+//+GPL
+
#define CLIENT_SUPPORT_READABLES(__sockPtr,__type)\
( ((__type)>0) &&\
((__sockPtr)->has_readable_type) && \
((__sockPtr)->supported_readables & (1<<(__type))) )
-/* Constants in the form EMI_ is for extended map infos.
- * Even if the client select the additionnal infos it wants
- * on the map, there may exist cases where this whole info
- * is not given in one buch but in separate bunches. This
- * is done performance reasons (imagine some info related to
- * a visible object and another info related to a 4 square
- * width and height area). At the begin of an extended info packet
- * is a bit field. A bit is activated for each extended info
- * present in the data
- */
-
-/* Meanings:
- * EMI_NOREDRAW Take extended infos into account but don't redraw,
- * some additionnal datas will follow in a new packet
- * EMI_SMOOTH Datas about smoothing
- */
-#define EMI_NOREDRAW 0x01
-#define EMI_SMOOTH 0x02
-
-/* this last one says the bitfield continue un next byte
- * There may be several on contiguous bytes. So there is 7
- * actual bits used per byte, and the number of bytes
- * is not fixed in protocol
- */
-#define EMI_HASMOREBITS 0x80
-
#define FACE_TYPES 1
#define PNG_FACE_INDEX 0
-#define VERSION_CS 1023 /* version >= 1023 understand setup cmd */
-#define VERSION_SC 1026
-//#define VERSION_SC 1027 // requestinfo image_info and image_sums, makes extending faces on the fly impossible
-#define VERSION_INFO "Crossfire+ Server"
+//-GPL
typedef object_vector sockvec;
@@ -326,5 +367,12 @@
for (int _i = 0; _i < clients.size (); ++_i) \
statementvar (client *, var, clients [_i])
+// returns true when the message needs special (read: perl) treatment
+static inline bool
+msg_is_special (const_any_string msg, bool nl_special = true)
+{
+ return msg [strcspn (msg, nl_special ? "<&\n" : "<&")];
+}
+
#endif