server.py

# -*- coding: UTF-8 -*-

# This program is free software. It comes without any warranty, to
# the extent permitted by applicable law. You can redistribute it
# and/or modify it under the terms of the Do What The Fuck You Want
# To Public License, Version 2, as published by Sam Hocevar. See
# http://www.wtfpl.net/ for more details.

from _socket import SHUT_RDWR
import locale
import logging
import logging.handlers
from uuid import uuid4
import sys
import socket
import datetime

from twisted.internet import reactor
from twisted.internet.error import CannotListenError
from twisted.internet.protocol import (
    ClientFactory,
    ServerFactory,
    Protocol,
    connectionDone
)
from twisted.internet.task import LoopingCall
from construct import Container
import construct.core

from packets import Packets, Direction, chat_received
from config import ConfigurationManager
from packet_stream import PacketStream
import packets
from plugin_manager import PluginManager, route, FatalPluginError
from utility_functions import build_packet

VERSION = '1.7.2'


VDEBUG_LVL = 9
logging.addLevelName(VDEBUG_LVL, 'VDEBUG')


def vdebug(self, message, *args, **kws):
    if self.isEnabledFor(VDEBUG_LVL):
        self._log(VDEBUG_LVL, message, args, **kws)


logging.Logger.vdebug = vdebug


def port_check(upstream_hostname, upstream_port):
    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    sock.settimeout(1)
    result = sock.connect_ex((upstream_hostname, upstream_port))

    if result != 0:
        sock.close()
        return False
    else:
        sock.shutdown(SHUT_RDWR)
        sock.close()

    return True


class StarryPyServerProtocol(Protocol):
    """
    The main protocol class for handling connections from Starbound clients.
    """

    def __init__(self):
        self.id = str(uuid4().hex)
        logger.vdebug('Creating protocol with ID %s.', self.id)
        self.factory.protocols[self.id] = self
        self.player = None
        self.state = None
        logger.debug('Trying to initialize configuration manager.')
        self.config = ConfigurationManager()
        self.parsing = False
        self.buffering_packet = None
        self.after_write_callback = None
        self.plugin_manager = None
        self.call_mapping = {
            Packets.PROTOCOL_VERSION: self.protocol_version,
            Packets.SERVER_DISCONNECT: self.server_disconnect,  # 1
            Packets.CONNECT_SUCCESS: self.connect_success,  # 2
            Packets.CONNECT_FAILURE: self.connect_failure,  # 3
            Packets.HANDSHAKE_CHALLENGE: self.handshake_challenge,  # 4
            Packets.CHAT_RECEIVED: self.chat_received,  # 5
            Packets.UNIVERSE_TIME_UPDATE: self.universe_time_update,  # 6
            Packets.CELESTIAL_RESPONSE: lambda x: True,  # 7
            Packets.PLAYER_WARP_RESULT: self.player_warp_result,  # 8
            Packets.CLIENT_CONNECT: self.client_connect,  # 9
            Packets.CLIENT_DISCONNECT_REQUEST: (
                self.client_disconnect_request  # 10
            ),
            Packets.HANDSHAKE_RESPONSE: self.handshake_response,  # 11
            Packets.PLAYER_WARP: self.player_warp,  # 12
            Packets.FLY_SHIP: self.fly_ship,  # 13
            Packets.CHAT_SENT: self.chat_sent,  # 14
            Packets.CELESTIAL_REQUEST: self.celestial_request,  # 15
            Packets.CLIENT_CONTEXT_UPDATE: self.client_context_update,  # 16
            Packets.WORLD_START: self.world_start,  # 17
            Packets.WORLD_STOP: self.world_stop,  # 18
            Packets.CENTRAL_STRUCTURE_UPDATE: (
                self.central_structure_update  # 19
            ),
            Packets.TILE_ARRAY_UPDATE: self.tile_array_update,  # 20
            Packets.TILE_UPDATE: self.tile_update,  # 21
            Packets.TILE_LIQUID_UPDATE: self.tile_liquid_update,  # 22
            Packets.TILE_DAMAGE_UPDATE: self.tile_damage_update,  # 23
            Packets.TILE_MODIFICATION_FAILURE: (
                self.tile_modification_failure  # 24
            ),
            Packets.GIVE_ITEM: self.give_item,  # 25
            Packets.SWAP_IN_CONTAINER_RESULT: (
                self.swap_in_container_result  # 26
            ),
            Packets.ENVIRONMENT_UPDATE: self.environment_update,  # 27
            Packets.ENTITY_INTERACT_RESULT: self.entity_interact_result,  # 28
            Packets.UPDATE_TILE_PROTECTION: self.update_tile_protection,  # 29
            Packets.MODIFY_TILE_LIST: self.modify_tile_list,  # 30
            Packets.DAMAGE_TILE_GROUP: self.damage_tile_group,  # 31
            Packets.COLLECT_LIQUID: self.collect_liquid,  # 32
            Packets.REQUEST_DROP: self.request_drop,  # 33
            Packets.SPAWN_ENTITY: self.spawn_entity,  # 34
            Packets.ENTITY_INTERACT: self.entity_interact,  # 35
            Packets.CONNECT_WIRE: self.connect_wire,  # 36
            Packets.DISCONNECT_ALL_WIRES: self.disconnect_all_wires,  # 37
            Packets.OPEN_CONTAINER: self.open_container,  # 38
            Packets.CLOSE_CONTAINER: self.close_container,  # 39
            Packets.SWAP_IN_CONTAINER: self.swap_in_container,  # 40
            Packets.ITEM_APPLY_IN_CONTAINER: (
                self.item_apply_in_container  # 41
            ),
            Packets.START_CRAFTING_IN_CONTAINER: (
                self.start_crafting_in_container  # 42
            ),
            Packets.STOP_CRAFTING_IN_CONTAINER: (
                self.stop_crafting_in_container  # 43
            ),
            Packets.BURN_CONTAINER: self.burn_container,  # 44
            Packets.CLEAR_CONTAINER: self.clear_container,  # 45
            Packets.WORLD_CLIENT_STATE_UPDATE: (
                self.world_client_state_update  # 46
            ),
            Packets.ENTITY_CREATE: self.entity_create,  # 47
            Packets.ENTITY_UPDATE: self.entity_update,  # 48
            Packets.ENTITY_DESTROY: self.entity_destroy,  # 49
            Packets.HIT_REQUEST: self.hit_request,  # 50
            Packets.DAMAGE_REQUEST: lambda x: True,  # 51
            Packets.DAMAGE_NOTIFICATION: self.damage_notification,  # 52
            Packets.ENTITY_MESSAGE: lambda x: True,  # 53
            Packets.ENTITY_MESSAGE_RESPONSE: lambda x: True,  # 54
            Packets.UPDATE_WORLD_PROPERTIES: (
                self.update_world_properties  # 55
            ),
            Packets.STEP_UPDATE: self.step_update,  # 56
        }
        self.client_protocol = None
        self.packet_stream = PacketStream(self)
        self.packet_stream.direction = Direction.CLIENT
        self.plugin_manager = self.factory.plugin_manager

    def connectionMade(self):
        """
        Called when the connection to the requesting client is actually
        established.

        After the connection is established, it attempts to connect to the
        actual starbound server using StarboundClientFactory()
        :rtype : None
        """
        logger.info(
            'Connection established from IP: %s',
            self.transport.getPeer().host
        )
        reactor.connectTCP(
            self.config.upstream_hostname,
            self.config.upstream_port,
            StarboundClientFactory(self),
            timeout=self.config.server_connect_timeout
        )

    def string_received(self, packet):
        """
        This method is called whenever a completed packet is received from the
        client going to the Starbound server.
        This is the first and only time where these packets can be modified,
        stopped, or allowed.

        Processing of parsed data is handled in handle_starbound_packets()
        :rtype : None
        """
        if 56 >= packet.id:
            if self.handle_starbound_packets(packet):
                self.client_protocol.transport.write(
                    packet.original_data)
                if self.after_write_callback is not None:
                    self.after_write_callback()
        else:
            # We received an unknown packet; send it along.
            logger.warning(
                'Received unknown message ID (%d) from client.', packet.id
            )
            self.client_protocol.transport.write(
                packet.original_data)

    def dataReceived(self, data):
        """
        Called whenever a packet is received. Generally this should not be
        tampered with directly, as it attempts to reconstruct the packet
        that Starbound clients send out.

        The actual handling of the reconstructed packet should be done in
        string_received(), which is called when the packet is built.

        :param data: Raw packet data from Twisted.

        :rtype : None
        """
        if self.config.passthrough:
            self.client_protocol.transport.write(data)

        else:
            self.packet_stream += data

    @route
    def protocol_version(self, data):
        return True

    @route
    def server_disconnect(self, data):
        return True

    @route
    def handshake_challenge(self, data):
        return True

    @route
    def chat_received(self, data):
        return True

    @route
    def universe_time_update(self, data):
        return True

    @route
    def handshake_response(self, data):
        return True

    @route
    def client_context_update(self, data):
        return True

    @route
    def world_start(self, data):
        return True

    @route
    def world_stop(self, data):
        return True

    @route
    def central_structure_update(self, data):
        return True

    @route
    def tile_array_update(self, data):
        return True

    @route
    def tile_update(self, data):
        return True

    @route
    def tile_liquid_update(self, data):
        return True

    @route
    def tile_damage_update(self, data):
        return True

    @route
    def tile_modification_failure(self, data):
        return True

    @route
    def give_item(self, data):
        return True

    @route
    def swap_in_container_result(self, data):
        return True

    @route
    def environment_update(self, data):
        return True

    @route
    def entity_interact_result(self, data):
        return True

    @route
    def update_tile_protection(self, data):
        return True

    @route
    def modify_tile_list(self, data):
        return True

    @route
    def damage_tile(self, data):
        return True

    @route
    def damage_tile_group(self, data):
        return True

    @route
    def collect_liquid(self, data):
        return True

    @route
    def request_drop(self, data):
        return True

    @route
    def spawn_entity(self, data):
        return True

    @route
    def entity_interact(self, data):
        return True

    @route
    def connect_wire(self, data):
        return True

    @route
    def disconnect_all_wires(self, data):
        return True

    @route
    def open_container(self, data):
        return True

    @route
    def close_container(self, data):
        return True

    @route
    def swap_in_container(self, data):
        return True

    @route
    def item_apply_in_container(self, data):
        return True

    @route
    def start_crafting_in_container(self, data):
        return True

    @route
    def stop_crafting_in_container(self, data):
        return True

    @route
    def burn_container(self, data):
        return True

    @route
    def clear_container(self, data):
        return True

    @route
    def world_client_state_update(self, data):
        return True

    @route
    def entity_create(self, data):
        return True

    @route
    def entity_update(self, data):
        return True

    @route
    def entity_destroy(self, data):
        return True

    @route
    def hit_request(self, data):
        return True

    @route
    def status_effect_request(self, data):
        return True

    @route
    def update_world_properties(self, data):
        return True

    @route
    def step_update(self, data):
        return True

    @route
    def connect_success(self, data):
        """
        Called when the server successfully connects with the client.

        :param data: Parsed packet.
        :rtype : bool
        """
        return True

    @route
    def connect_failure(self, data):
        """
        Called when the server fails to connect with the client.

        :param data: Parsed packet.
        :rtype : bool
        """
        return True

    @route
    def chat_sent(self, data):
        """
        Called when the client attempts to send a chat message/command to the
        server.

        :param data: Parsed chat packet.
        :rtype : bool
        """
        return True

    @route
    def celestial_request(self, data):
        """
        Called when the client requests celestial data...?

        :param data: Parsed chat packet.
        :rtype : bool
        """
        return True

    @route
    def damage_notification(self, data):
        return True

    @route
    def client_connect(self, data):
        """
        Called when the client attempts to connect to the Starbound server.

        :param data: Parsed client_connect packet.
        :rtype : bool
        """
        return True

    @route
    def client_disconnect_request(self, player):
        """
        Called when the client signals that it is about to disconnect from
        the Starbound server.

        :param player: The Player.
        :rtype : bool
        """
        return True

    @route
    def player_warp(self, data):
        """
        Called when the players issues a warp.

        :param data: The player_warp data.
        :rtype : bool
        """
        return True

    @route
    def player_warp_result(self, data):
        """
        Called when the players begins to warp.

        :param data: The player_warp data.
        :rtype : bool
        """
        return True

    @route
    def fly_ship(self, data):
        """
        Called when the players moves their ship.

        :param data: The fly_ship data.
        :rtype : bool
        """
        return True

    def handle_starbound_packets(self, p):
        """
        This function is the meat of it all. Every time a full packet with
        a derived ID <= 56, it is passed through here.
        """
        return self.call_mapping[p.id](p)

    def send_chat_message(self, text, mode='BROADCAST', channel='', name=''):
        """
        Convenience function to send chat messages to the client. Note that
        this does *not* send messages to the server at large; broadcast should
        be used for messages to all clients, or manually constructed chat
        messages otherwise.

        :param text: Message text, may contain multiple lines.
        :param channel: The chat channel/context.
        :param name: The name to display before the message. Blank leaves no
        brackets, otherwise it will be displayed as `<name>`.
        :return: None
        """
        if '\n' in text:
            lines = text.split('\n')
            for line in lines:
                self.send_chat_message(line)
            return
        if self.player is not None:
            logger.vdebug(
                'Calling send_chat_message from player %s on channel'
                ' %s with mode %s with reported username of %s with'
                ' message: %s',
                self.player.name,
                channel,
                mode,
                name,
                text
            )
        chat_data = chat_received().build(
            Container(
                mode=mode,
                channel=channel,
                client_id=0,
                name=name,
                message=text.encode('utf-8')
            )
        )
        logger.vdebug('Built chat payload. Data: %s', chat_data.encode('hex'))
        chat_packet = build_packet(
            packets.Packets.CHAT_RECEIVED, chat_data
        )
        logger.vdebug('Built chat packet. Data: %s', chat_packet.encode('hex'))
        self.transport.write(chat_packet)
        logger.vdebug('Sent chat message with text: %s', text)

    def write(self, data):
        """
        Convenience method to send data to the client.
        :param data: Data to send.
        :return: None
        """
        self.transport.write(data)

    def connectionLost(self, reason=connectionDone):
        """
        Called as a pseudo-destructor when the connection is lost.
        :param reason: The reason for the disconnection.
        :return: None
        """
        try:
            logger.vdebug('Trying to disconnect protocol from factory')
            if self.client_protocol is not None:
                logger.vdebug('The client_protocol is not None')
                x = build_packet(
                    packets.Packets.CLIENT_DISCONNECT_REQUEST,
                    packets.client_disconnect_request().build(
                        Container(data=0)
                    )
                )
                logger.vdebug('Disconnect packet has been built')
                try:
                    if self.player is not None and self.player.logged_in:
                        logger.vdebug('Player not none and is still logged in')
                        self.client_disconnect_request(x)
                        logger.vdebug('Client disconnect requested')
                except:
                    logger.error('Couldn\'t complete disconnect request.')
                finally:
                    self.client_protocol.transport.write(x)
                    logger.vdebug('Kill packet written to transport protocol')
                    self.client_protocol.transport.abortConnection()
                    logger.vdebug('connection aborted')
                    self.player.logged_in = 0
                    logger.vdebug('Player status forced to logged_in=0')
        except:
            logger.error('Couldn\'t disconnect protocol.')
        finally:
            try:
                self.factory.protocols.pop(self.id)
            except:
                logger.warning(
                    'Protocol was not in factory list. This should not happen.'
                )
                logger.info('protocol id: %s' % self.id)
            finally:
                logger.info(
                    'Lost connection from IP: %s',
                    self.transport.getPeer().host
                )
                logger.vdebug('Connection aborted')
                self.transport.abortConnection()

    def die(self):
        self.connectionLost()


class ClientProtocol(Protocol):
    """
    The protocol class which handles the connection to the Starbound server.
    """

    def __init__(self):
        self.packet_stream = PacketStream(self)
        self.packet_stream.direction = packets.Direction.SERVER
        logger.debug('Client protocol instantiated.')

    def connectionMade(self):
        """
        Called when the connection to the Starbound server is initially
        established. Inserts a self-reference in the server_protocol to allow
        two-way communication.

        :return: None
        """
        self.server_protocol.client_protocol = self

    def string_received(self, packet):
        """
        This method is called whenever a completed packet is received from the
        Starbound server.

        This is the first and only time where these packets can be modified,
        stopped, or allowed.

        Processing of parsed data is handled in handle_starbound_packets()

        :return: None
        """
        try:
            if self.server_protocol.handle_starbound_packets(
                    packet):
                self.server_protocol.write(packet.original_data)
        except construct.core.FieldError:
            logger.exception('Construct field error in string_received.')
            self.server_protocol.write(
                packet.original_data)

    def dataReceived(self, data):
        """
        Called whenever a packet is received. Generally this should not be
        tampered with directly, as it attempts to reconstruct the packet
        that the Starbound server sent out.

        The actual handling of the reconstructed packet should be done in
        string_received(), which is called when the packet is built.
        :param data: Raw packet data from the Starbound server.
        :return: None
        """
        if self.server_protocol.config.passthrough:
            self.server_protocol.write(data)
        else:
            self.packet_stream += data

    def disconnect(self):
        logger.vdebug('Client protocol disconnect called.')
        x = build_packet(
            packets.Packets.CLIENT_DISCONNECT_REQUEST,
            packets.client_disconnect_request().build(Container(data=0))
        )
        self.transport.write(x)
        self.transport.abortConnection()
        logger.vdebug('Client protocol disconnected.')


class StarryPyServerFactory(ServerFactory):
    """
    Factory which creates `StarryPyServerProtocol` instances.
    """
    protocol = StarryPyServerProtocol

    def __init__(self):
        """
        Initializes persistent objects and prepares a list of connected
        protocols.
        """
        self.config = ConfigurationManager()
        self.protocol.factory = self
        self.protocols = {}
        self.plugin_manager = PluginManager(factory=self)
        try:
            self.plugin_manager.prepare()
        except FatalPluginError:
            logger.critical('Shutting Down.')
            sys.exit()
        self.reaper = LoopingCall(self.reap_dead_protocols)
        self.reaper.start(self.config.reap_time)
        logger.debug(
            'Factory created, endpoint of port %d', self.config.bind_port
        )

    def stopFactory(self):
        """
        Called when the factory is stopped. Saves the configuration.
        :return: None
        """

        self.config.save()
        self.plugin_manager.die()

    def broadcast(self, text, name=''):
        """
        Convenience method to send a broadcasted message to all clients on the
        server.

        :param text: Message text
        :param name: The name to prepend before the message, format is <name>
        :return: None
        """
        for p in self.protocols.itervalues():
            try:
                p.send_chat_message(text)
            except:
                logger.exception('Exception in broadcast.')

    def broadcast_planet(self, text, planet, name=''):
        """
        Convenience method to send a broadcasted message to all clients on the
        current planet (and ships orbiting it).

        :param text: Message text
        :param planet: The planet to send the message to
        :param name: The name to prepend before the message, format is <name>,
         not prepended when empty
        :return: None
        """
        for p in self.protocols.itervalues():
            if p.player.planet == planet:
                try:
                    p.send_chat_message(text)
                except:
                    logger.exception('Exception in broadcast.')

    def buildProtocol(self, address):
        """
        Builds the protocol to a given address.

        :rtype : Protocol
        """
        logger.vdebug('Building protocol to address %s', address)
        p = ServerFactory.buildProtocol(self, address)
        return p

    def reap_dead_protocols(self):
        logger.vdebug('Reaping dead connections.')
        count = 0
        start_time = datetime.datetime.now()
        for protocol in self.protocols.itervalues():
            total_seconds = (
                protocol
                .client_protocol
                .packet_stream
                .last_received_timestamp -
                start_time
            ).total_seconds()
            if total_seconds > self.config.reap_time:
                logger.debug(
                    'Reaping protocol %s. Reason: Server protocol timeout.',
                    protocol.id
                )
                protocol.connectionLost()
                count += 1
                continue
            if (
                    protocol.client_protocol is not None and
                    total_seconds > self.config.reap_time
            ):
                protocol.connectionLost()
                logger.debug(
                    'Reaping protocol %s. Reason: Client protocol timeout.',
                    protocol.id
                )
                count += 1
        if count == 1:
            logger.info('1 connection reaped.')
        elif count > 1:
            logger.info('%d connections reaped.')
        else:
            logger.vdebug('No connections reaped.')


class StarboundClientFactory(ClientFactory):
    """
    Factory which creates `StarboundClientProtocol` instances.
    """
    protocol = ClientProtocol

    def __init__(self, server_protocol):
        logger.vdebug('Client protocol instantiated in client factory.')
        self.server_protocol = server_protocol

    def buildProtocol(self, address):
        logger.vdebug(
            'Building protocol in StarboundClientFactory to address %s',
            address
        )
        protocol = ClientFactory.buildProtocol(self, address)
        protocol.server_protocol = self.server_protocol
        return protocol


def init_localization():
    try:
        locale.setlocale(locale.LC_ALL, '')
    except:
        locale.setlocale(locale.LC_ALL, 'en_US.utf8')


if __name__ == '__main__':
    init_localization()

    print('Attempting initialization of configuration manager singleton.')
    config = ConfigurationManager()

    logger = logging.getLogger('starrypy')
    logger.setLevel(9)
    log_format = logging.Formatter(
        '%(asctime)s - %(levelname)s - %(name)s # %(message)s'
    )
    if config.log_level == 'DEBUG':
        log_level = logging.DEBUG
    elif config.log_level == 'VDEBUG':
        log_level = 'VDEBUG'
    else:
        log_level = logging.INFO

    print('Setup console logging...')
    console_handle = logging.StreamHandler(sys.stdout)
    console_handle.setLevel(log_level)
    logger.addHandler(console_handle)
    console_handle.setFormatter(log_format)

    print('Setup file-based logging...')
    logfile_handle = logging.handlers.TimedRotatingFileHandler(
        'server.log', when='midnight', interval=5, backupCount=4
    )
    logfile_handle.setLevel(log_level)
    logger.addHandler(logfile_handle)
    logfile_handle.setFormatter(log_format)

    if config.port_check:
        logger.debug(
            'Port check enabled. Performing port check to %s:%d',
            config.upstream_hostname,
            config.upstream_port
        )

        if not port_check(config.upstream_hostname, config.upstream_port):
            logger.critical(
                'The starbound server is not connectable at the address'
                ' %s:%d.', config.upstream_hostname, config.upstream_port
            )
            logger.critical(
                'Please ensure that you are running starbound_server on the '
                'correct port and that is reflected in the StarryPy '
                'configuration.'
            )
            sys.exit()

        logger.debug('Port check succeeded. Continuing.')

    logger.info('Started StarryPy server version %s', VERSION)
    factory = StarryPyServerFactory()
    logger.debug(
        'Attempting to listen on TCP port %d', factory.config.bind_port
    )

    try:
        reactor.listenTCP(
            factory.config.bind_port,
            factory,
            interface=factory.config.bind_address
        )
    except CannotListenError:
        logger.critical(
            'Cannot listen on TCP port %d. Exiting.', factory.config.bind_port
        )
        sys.exit()

    logger.info('Listening on port %s', factory.config.bind_port)
    reactor.run()