/*
* This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
*
* 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
*
* 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 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.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*
* The authors can be reached via e-mail to
*/
#ifndef CLIENT_H
#define CLIENT_H
#include
#include
#include
// (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
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
unsigned char flags;
uint8_t smooth[MAP_LAYERS];
};
#define MAX_CLIENT_X MAP_CLIENT_X
#define MAX_CLIENT_Y MAP_CLIENT_Y
struct Map
{
struct MapCell cells[MAX_CLIENT_X][MAX_CLIENT_Y];
};
/* True max is 16383 given current map compaction method */
#define MAXANIMNUM 10000
struct statsinfo
{
char *range, *title;
};
/* This contains basic information on the socket structure. status is its
* current state. we set up our on buffers for sending/receiving, so we can
* handle some higher level functions. fd is the actual file descriptor we
* are using.
*/
/* Only one map mode can actually be used, so lets make it a switch
* instead of having a bunch of different fields that needed to
* get toggled.
*/
enum { Map0Cmd = 0, Map1Cmd = 1, Map1aCmd = 2 };
// states the socket can be in
enum {
ST_DEAD, // socket is dead
ST_SETUP, // initial handshake / setup / login
ST_PLAYING, // logged in an playing
ST_CUSTOM, // waiting for custom reply
ST_GET_PARTY_PASSWORD,
};
// a handler for a specific type of packet
enum {
PF_PLAYER = 0x01, // must have valid player / will by synchronised
PF_PLAYING = 0x02, // must be in playing state
PF_COMMAND0 = 0x04, // command starts at offset 0
PF_COMMAND6 = 0x08, // command starts at offset 6
};
struct packet_type
{
const char *name;
void *cb;
int flags;
};
struct command
{
tstamp stamp;
const packet_type *handler;
char *data;
int datalen;
~command ()
{
sfree (data, datalen + 1);
}
};
/* how many times we are allowed to give the wrong password before being kicked. */
#define MAX_PASSWORD_FAILURES 5
INTERFACE_CLASS (client) // should become player when newsocket is a baseclass of player
struct client : zero_initialised, attachable
{
int ACC (RW, fd);
unsigned int inbuf_len; // number of bytes valid in inbuf
statsinfo stats;
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 */
sint8 ACC (RW, last_level); /* Last level we sent to client */
uint16 ACC (RW, last_flags); /* fire/run on flags for last tick */
float ACC (RW, last_weapon_sp); /* if diff than weapon_sp, update client */
sint32 ACC (RW, last_weight); /* Last weight as sent to client; -1 means do not send weight */
sint32 ACC (RW, last_weight_limit); /* Last weight limit transmitted to client */
uint32 ACC (RW, last_path_attuned); /* Last spell attunment sent to client */
uint32 ACC (RW, last_path_repelled); /* Last spell repelled sent to client */
uint32 ACC (RW, last_path_denied); /* Last spell denied sent to client */
living ACC (RO, last_stats); /* Last stats as sent to client */
float ACC (RW, last_speed); /* Last speed as sent to client */
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 */
uint8_t ACC (RW, fxix); // client implements fx and ix (face|image extended) commands
bool ACC (RW, update_look); /* If true, we need to send the look window */
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, 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
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 */
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
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
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);
std::deque< command, slice_allocator > cmd_queue;
// large structures at the end please
struct Map lastmap;
std::bitset anims_sent;
std::bitset faces_sent;
// 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
uint8 inbuf[MAXSOCKBUF + 2 + 1];
enum { MSG_BUF_SIZE = 80, MSG_BUF_COUNT = 10 };
struct msg_buf
{
tick_t expire;
int len;
int count;
char msg[MSG_BUF_SIZE];
} msgbuf[MSG_BUF_COUNT];
MTH bool msg_suppressed (const char *msg);
bool may_execute (const packet_type *pkt) const;
void execute (const packet_type *pkt, char *data, int datalen);
void queue_command (packet_type *handler, char *data, int datalen);
MTH bool handle_command ();
// resets movement state
MTH void reset_state ();
// resets variable data used to send stat diffs
MTH void reset_stats ();
MTH bool handle_packet ();
int next_packet (); // returns length of packet or 0
void skip_packet (int len); // we have processed the packet, skip it
MTH void flush ();
MTH void write_outputbuffer ();
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 (packet &sl);
void send_drawinfo (const char *msg, int flags = NDI_BLACK);
MTH bool must_send_face (faceidx facenum)
{
if (faces_sent[facenum])
return false;
faces_sent[facenum] = true;
return true;
}
MTH void send_face (faceidx facenum);
MTH void send_image (faceidx facenum);
MTH void send_faces (object *ob);
MTH void send_animation (short anim_num);
void send_msg (int color, const char *type, const char *msg);
// called when something under the player changes
MTH void floorbox_update () { update_look = 1; }
// called when the player has been moved
MTH void floorbox_reset () { look_position = 0; floorbox_update (); }
MTH void tick (); // called every server tick to do housekeeping etc.
MTH static client *create (int fd, const char *peername);
protected:
client (int fd, const char *from_ip);
~client ();
};
#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 TRT Server"
typedef object_vector sockvec;
extern sockvec clients;
#define for_all_clients(var) \
for (int _i = 0; _i < clients.size (); ++_i) \
statementvar (client *, var, clients [_i])
#endif